@orpc/server 2.0.0-beta.4 → 2.0.0-beta.40
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 +97 -94
- package/dist/adapters/aws-lambda/index.d.mts +50 -0
- package/dist/adapters/aws-lambda/index.d.ts +50 -0
- package/dist/adapters/aws-lambda/index.mjs +39 -0
- package/dist/adapters/crossws/index.d.mts +21 -12
- package/dist/adapters/crossws/index.d.ts +21 -12
- package/dist/adapters/crossws/index.mjs +14 -10
- package/dist/adapters/fastify/index.d.mts +42 -0
- package/dist/adapters/fastify/index.d.ts +42 -0
- package/dist/adapters/fastify/index.mjs +39 -0
- package/dist/adapters/fetch/index.d.mts +21 -114
- package/dist/adapters/fetch/index.d.ts +21 -114
- package/dist/adapters/fetch/index.mjs +20 -182
- package/dist/adapters/message-port/index.d.mts +23 -20
- package/dist/adapters/message-port/index.d.ts +23 -20
- package/dist/adapters/message-port/index.mjs +31 -34
- package/dist/adapters/node/index.d.mts +19 -96
- package/dist/adapters/node/index.d.ts +19 -96
- package/dist/adapters/node/index.mjs +19 -157
- package/dist/adapters/standard/index.d.mts +91 -17
- package/dist/adapters/standard/index.d.ts +91 -17
- package/dist/adapters/standard/index.mjs +4 -4
- package/dist/adapters/standard-peer/index.d.mts +6 -11
- package/dist/adapters/standard-peer/index.d.ts +6 -11
- package/dist/adapters/standard-peer/index.mjs +10 -2
- package/dist/adapters/websocket/index.d.mts +45 -29
- package/dist/adapters/websocket/index.d.ts +45 -29
- package/dist/adapters/websocket/index.mjs +37 -28
- package/dist/extensions/callable.d.mts +5 -5
- package/dist/extensions/callable.d.ts +5 -5
- package/dist/extensions/callable.mjs +2 -2
- package/dist/helpers/index.d.mts +23 -6
- package/dist/helpers/index.d.ts +23 -6
- package/dist/helpers/index.mjs +13 -5
- package/dist/index.d.mts +332 -37
- package/dist/index.d.ts +332 -37
- package/dist/index.mjs +131 -49
- package/dist/plugins/index.d.mts +243 -31
- package/dist/plugins/index.d.ts +243 -31
- package/dist/plugins/index.mjs +527 -30
- package/dist/shared/server.1ExWFMze.mjs +69 -0
- package/dist/shared/{server.CjOb6ItT.mjs → server.24nXyhbl.mjs} +1 -1
- package/dist/shared/{server.DBANIheG.d.ts → server.B5K1CViq.d.mts} +24 -13
- package/dist/shared/{server.BsNNjG5J.d.mts → server.BpmUhems.d.mts} +32 -20
- package/dist/shared/{server.BL22TloH.d.mts → server.BsujoJoF.d.mts} +38 -59
- package/dist/shared/{server.BL22TloH.d.ts → server.BsujoJoF.d.ts} +38 -59
- package/dist/shared/{server.BwHnWUuN.mjs → server.BynNaBBA.mjs} +24 -19
- package/dist/shared/{server.GDpX6Df8.mjs → server.C0lFtoHU.mjs} +162 -68
- package/dist/shared/server.C7xllBNN.d.mts +34 -0
- package/dist/shared/server.CFqSIFnT.d.mts +14 -0
- package/dist/shared/{server.Pa0F03f_.d.ts → server.CRwPbhLO.d.ts} +32 -20
- package/dist/shared/{server.DJIkub_t.d.mts → server.Cxranw-8.d.ts} +24 -13
- package/dist/shared/server.D0dr-F8u.d.ts +34 -0
- package/dist/shared/{server.CrlKQucM.mjs → server.Djb_ebJT.mjs} +25 -53
- package/dist/shared/server.RRVK1xTV.d.ts +14 -0
- package/package.json +47 -14
- package/dist/shared/server.CX4vUnDk.mjs +0 -11
- package/dist/shared/server.Cj5lgPuG.d.mts +0 -66
- package/dist/shared/server.D_QauotT.mjs +0 -30
- package/dist/shared/server.d_2NS3g5.d.ts +0 -66
|
@@ -1,204 +1,42 @@
|
|
|
1
|
-
|
|
2
|
-
import {
|
|
3
|
-
import { toStandardLazyRequest, toFetchResponse } from '@
|
|
1
|
+
export { R as BodyLimitPlugin } from '../../shared/server.1ExWFMze.mjs';
|
|
2
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { toStandardLazyRequest, toFetchResponse } from '@standard-server/fetch';
|
|
4
4
|
import { r as resolveFriendlyStandardHandlerHandleOptions } from '../../shared/server.W91HSRkE.mjs';
|
|
5
|
-
import {
|
|
6
|
-
import
|
|
7
|
-
import '@
|
|
8
|
-
import '../../shared/server.
|
|
5
|
+
import { R as RPCHandlerCodec, S as StandardHandler } from '../../shared/server.C0lFtoHU.mjs';
|
|
6
|
+
import '@orpc/client';
|
|
7
|
+
import '@standard-server/core';
|
|
8
|
+
import '../../shared/server.Djb_ebJT.mjs';
|
|
9
9
|
import '@orpc/contract';
|
|
10
|
-
import '../../shared/server.
|
|
11
|
-
|
|
12
|
-
const ORDERED_SUPPORTED_ENCODINGS = ["gzip", "deflate"];
|
|
13
|
-
class BodyCompressionHandlerPlugin {
|
|
14
|
-
name = "~body-compression";
|
|
15
|
-
encodings;
|
|
16
|
-
threshold;
|
|
17
|
-
filter;
|
|
18
|
-
constructor(options = {}) {
|
|
19
|
-
this.encodings = options.encodings ?? ORDERED_SUPPORTED_ENCODINGS;
|
|
20
|
-
this.threshold = options.threshold ?? 1024;
|
|
21
|
-
this.filter = (request, response) => {
|
|
22
|
-
const hasContentDisposition = response.headers.has("content-disposition");
|
|
23
|
-
const contentType = response.headers.get("content-type");
|
|
24
|
-
if (!hasContentDisposition && contentType?.startsWith("text/event-stream")) {
|
|
25
|
-
return false;
|
|
26
|
-
}
|
|
27
|
-
return options.filter ? options.filter(request, response) : isCompressibleContentType(contentType);
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
initFetchHandlerOptions(options) {
|
|
31
|
-
return {
|
|
32
|
-
...options,
|
|
33
|
-
fetchInterceptors: [
|
|
34
|
-
async (interceptorOptions) => {
|
|
35
|
-
const result = await interceptorOptions.next();
|
|
36
|
-
if (!result.matched) {
|
|
37
|
-
return result;
|
|
38
|
-
}
|
|
39
|
-
const response = result.response;
|
|
40
|
-
if (response.headers.has("content-encoding") || response.headers.has("transfer-encoding") || isNoTransformCacheControl(response.headers.get("cache-control"))) {
|
|
41
|
-
return result;
|
|
42
|
-
}
|
|
43
|
-
const contentLength = response.headers.get("content-length");
|
|
44
|
-
if (contentLength && Number(contentLength) < this.threshold) {
|
|
45
|
-
return result;
|
|
46
|
-
}
|
|
47
|
-
const acceptEncoding = interceptorOptions.request.headers.get("accept-encoding")?.split(",").map((enc) => enc.trim().split(";")[0]);
|
|
48
|
-
const encoding = this.encodings.find((enc) => acceptEncoding?.includes(enc));
|
|
49
|
-
if (!response.body || encoding === void 0) {
|
|
50
|
-
return result;
|
|
51
|
-
}
|
|
52
|
-
if (!this.filter(interceptorOptions.request, response)) {
|
|
53
|
-
return result;
|
|
54
|
-
}
|
|
55
|
-
const compressedBody = response.body.pipeThrough(new CompressionStream(encoding));
|
|
56
|
-
const compressedHeaders = new Headers(response.headers);
|
|
57
|
-
compressedHeaders.delete("content-length");
|
|
58
|
-
compressedHeaders.set("content-encoding", encoding);
|
|
59
|
-
return {
|
|
60
|
-
...result,
|
|
61
|
-
response: new Response(compressedBody, {
|
|
62
|
-
status: response.status,
|
|
63
|
-
statusText: response.statusText,
|
|
64
|
-
headers: compressedHeaders
|
|
65
|
-
})
|
|
66
|
-
};
|
|
67
|
-
},
|
|
68
|
-
...toArray(options.fetchInterceptors)
|
|
69
|
-
]
|
|
70
|
-
};
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
const COMPRESSIBLE_CONTENT_TYPE_REGEX = /^\s*(?:text\/(?!event-stream(?:[;\s]|$))[^;\s]+|application\/(?:javascript|json|xml|xml-dtd|ecmascript|dart|postscript|rtf|tar|toml|vnd\.dart|vnd\.ms-fontobject|vnd\.ms-opentype|wasm|x-httpd-php|x-javascript|x-ns-proxy-autoconfig|x-sh|x-tar|x-virtualbox-hdd|x-virtualbox-ova|x-virtualbox-ovf|x-virtualbox-vbox|x-virtualbox-vdi|x-virtualbox-vhd|x-virtualbox-vmdk|x-www-form-urlencoded)|font\/(?:otf|ttf)|image\/(?:bmp|vnd\.adobe\.photoshop|vnd\.microsoft\.icon|vnd\.ms-dds|x-icon|x-ms-bmp)|message\/rfc822|model\/gltf-binary|x-shader\/x-fragment|x-shader\/x-vertex|[^;\s]+?\+(?:json|text|xml|yaml))(?:[;\s]|$)/i;
|
|
74
|
-
function isCompressibleContentType(contentType) {
|
|
75
|
-
if (contentType === null) {
|
|
76
|
-
return false;
|
|
77
|
-
}
|
|
78
|
-
return COMPRESSIBLE_CONTENT_TYPE_REGEX.test(contentType);
|
|
79
|
-
}
|
|
80
|
-
const CACHE_CONTROL_NO_TRANSFORM_REGEX = /(?:^|,)\s*no-transform\s*(?:,|$)/i;
|
|
81
|
-
function isNoTransformCacheControl(cacheControl) {
|
|
82
|
-
if (cacheControl === null) {
|
|
83
|
-
return false;
|
|
84
|
-
}
|
|
85
|
-
return CACHE_CONTROL_NO_TRANSFORM_REGEX.test(cacheControl);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
class BodyLimitHandlerPlugin {
|
|
89
|
-
name = "~body-limit";
|
|
90
|
-
maxBodySize;
|
|
91
|
-
constructor(options) {
|
|
92
|
-
this.maxBodySize = options.maxBodySize;
|
|
93
|
-
}
|
|
94
|
-
initFetchHandlerOptions(options) {
|
|
95
|
-
return {
|
|
96
|
-
...options,
|
|
97
|
-
fetchInterceptors: [
|
|
98
|
-
async (interceptorOptions) => {
|
|
99
|
-
if (!interceptorOptions.request.body) {
|
|
100
|
-
return interceptorOptions.next();
|
|
101
|
-
}
|
|
102
|
-
let currentBodySize = 0;
|
|
103
|
-
const rawReader = interceptorOptions.request.body.getReader();
|
|
104
|
-
const body = new ReadableStream({
|
|
105
|
-
start: async (controller) => {
|
|
106
|
-
const reject = async (error) => {
|
|
107
|
-
controller.error(error);
|
|
108
|
-
await rawReader.cancel(error);
|
|
109
|
-
};
|
|
110
|
-
const contentLength = interceptorOptions.request.headers.get("content-length");
|
|
111
|
-
if (contentLength && Number(contentLength) > this.maxBodySize) {
|
|
112
|
-
await reject(new ORPCError("PAYLOAD_TOO_LARGE"));
|
|
113
|
-
return;
|
|
114
|
-
}
|
|
115
|
-
while (true) {
|
|
116
|
-
const { done, value } = await rawReader.read();
|
|
117
|
-
if (done) {
|
|
118
|
-
controller.close();
|
|
119
|
-
return;
|
|
120
|
-
}
|
|
121
|
-
currentBodySize += value.length;
|
|
122
|
-
if (currentBodySize > this.maxBodySize) {
|
|
123
|
-
await reject(new ORPCError("PAYLOAD_TOO_LARGE"));
|
|
124
|
-
return;
|
|
125
|
-
}
|
|
126
|
-
controller.enqueue(value);
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
});
|
|
130
|
-
const requestInit = { body, duplex: "half" };
|
|
131
|
-
return interceptorOptions.next({
|
|
132
|
-
...interceptorOptions,
|
|
133
|
-
request: new Request(interceptorOptions.request, requestInit)
|
|
134
|
-
});
|
|
135
|
-
},
|
|
136
|
-
...toArray(options.fetchInterceptors)
|
|
137
|
-
]
|
|
138
|
-
};
|
|
139
|
-
}
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
class CompositeFetchHandlerPlugin {
|
|
143
|
-
name = "~composite/fetch-handler";
|
|
144
|
-
plugins;
|
|
145
|
-
constructor(plugins = []) {
|
|
146
|
-
this.plugins = sortPlugins(plugins);
|
|
147
|
-
}
|
|
148
|
-
initFetchHandlerOptions(options) {
|
|
149
|
-
for (const plugin of this.plugins) {
|
|
150
|
-
if (plugin.initFetchHandlerOptions) {
|
|
151
|
-
options = plugin.initFetchHandlerOptions(options);
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
return options;
|
|
155
|
-
}
|
|
156
|
-
}
|
|
10
|
+
import '../../shared/server.BynNaBBA.mjs';
|
|
157
11
|
|
|
158
12
|
class FetchHandler {
|
|
159
13
|
constructor(standardHandler, options = {}) {
|
|
160
14
|
this.standardHandler = standardHandler;
|
|
161
|
-
options = new CompositeFetchHandlerPlugin(options.plugins).initFetchHandlerOptions(options);
|
|
162
|
-
this.fetchInterceptors = options.fetchInterceptors;
|
|
163
15
|
this.toFetchResponseOptions = options.toFetchResponse;
|
|
164
16
|
}
|
|
165
17
|
toFetchResponseOptions;
|
|
166
|
-
fetchInterceptors;
|
|
167
18
|
async handle(request, ...rest) {
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
request,
|
|
173
|
-
toFetchResponseOptions: this.toFetchResponseOptions
|
|
174
|
-
},
|
|
175
|
-
async ({ request: request2, toFetchResponseOptions, ...options }) => {
|
|
176
|
-
const standardRequest = toStandardLazyRequest(request2);
|
|
177
|
-
const result = await this.standardHandler.handle(standardRequest, options);
|
|
178
|
-
if (!result.matched) {
|
|
179
|
-
return result;
|
|
180
|
-
}
|
|
181
|
-
return {
|
|
182
|
-
matched: true,
|
|
183
|
-
response: toFetchResponse(result.response, toFetchResponseOptions)
|
|
184
|
-
};
|
|
185
|
-
}
|
|
19
|
+
const standardRequest = toStandardLazyRequest(request);
|
|
20
|
+
const result = await this.standardHandler.handle(
|
|
21
|
+
standardRequest,
|
|
22
|
+
resolveFriendlyStandardHandlerHandleOptions(resolveMaybeOptionalOptions(rest))
|
|
186
23
|
);
|
|
24
|
+
if (!result.matched) {
|
|
25
|
+
return result;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
matched: true,
|
|
29
|
+
response: toFetchResponse(result.response, this.toFetchResponseOptions)
|
|
30
|
+
};
|
|
187
31
|
}
|
|
188
32
|
}
|
|
189
33
|
|
|
190
34
|
class RPCHandler extends FetchHandler {
|
|
191
35
|
constructor(router, options = {}) {
|
|
192
|
-
if (options.csrfGuardHandlerPlugin?.enabled !== false) {
|
|
193
|
-
options = {
|
|
194
|
-
...options,
|
|
195
|
-
plugins: [...toArray(options.plugins), new CSRFGuardHandlerPlugin()]
|
|
196
|
-
};
|
|
197
|
-
}
|
|
198
36
|
const codec = new RPCHandlerCodec(router, options);
|
|
199
37
|
const handler = new StandardHandler(codec, options);
|
|
200
38
|
super(handler, options);
|
|
201
39
|
}
|
|
202
40
|
}
|
|
203
41
|
|
|
204
|
-
export {
|
|
42
|
+
export { FetchHandler, RPCHandler };
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { SupportedMessagePort } from '@orpc/client/message-port';
|
|
2
2
|
import { Value, Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import { ServerPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
3
|
+
import { ServerPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
|
|
4
|
+
import { Context } from '../../index.mjs';
|
|
5
|
+
import { StandardHandler, StandardHandlerOptions } from '../standard/index.mjs';
|
|
6
|
+
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.mjs';
|
|
7
|
+
import { Router } from '../../index.mjs';
|
|
8
|
+
import { RPCHandlerCodecOptions } from '../standard/index.mjs';
|
|
9
9
|
import '@orpc/client';
|
|
10
10
|
import '@orpc/contract';
|
|
11
|
-
import '@
|
|
11
|
+
import '@standard-server/core';
|
|
12
12
|
|
|
13
13
|
type DecodedResponseMessage = ConstructorParameters<typeof ServerPeer>[0] extends (message: infer TMessage) => unknown ? TMessage : never;
|
|
14
14
|
interface MessagePortHandlerOptions<_T extends Context> {
|
|
@@ -19,9 +19,8 @@ interface MessagePortHandlerOptions<_T extends Context> {
|
|
|
19
19
|
* such as transferring object ownership or supporting non-serializable objects like `OffscreenCanvas` or improving performance.
|
|
20
20
|
*
|
|
21
21
|
* @remarks
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* @warning Ensure your message port implementation supports `transferable` objects before enabling this.
|
|
22
|
+
* **Note**: Returning `null` or `undefined` disables this feature.
|
|
23
|
+
* **Warning**: Ensure your message port implementation supports `transferable` objects before enabling this.
|
|
25
24
|
*/
|
|
26
25
|
experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]>;
|
|
27
26
|
/**
|
|
@@ -41,31 +40,35 @@ declare class MessagePortHandler<T extends Context> {
|
|
|
41
40
|
private readonly decodePeerMessageOptions;
|
|
42
41
|
constructor(handler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
|
|
43
42
|
/**
|
|
44
|
-
* Attaches
|
|
43
|
+
* Attaches message and close listeners to a message port.
|
|
44
|
+
*
|
|
45
|
+
* Prefer this over calling `.message()` and `.close()` manually.
|
|
45
46
|
*/
|
|
46
|
-
upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<
|
|
47
|
+
upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
|
|
47
48
|
/**
|
|
48
49
|
* Handles a single message received from a message port.
|
|
49
50
|
*
|
|
50
|
-
* @
|
|
51
|
-
*
|
|
52
|
-
* @param port The message port instance, require consistent instance across messages for proper peer management
|
|
51
|
+
* @param port The message port instance. Use the same instance for all messages.
|
|
53
52
|
*/
|
|
54
|
-
message(port: SupportedMessagePort, data:
|
|
53
|
+
message(port: SupportedMessagePort, data: unknown, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
|
|
55
54
|
matched: boolean;
|
|
56
55
|
}>;
|
|
57
56
|
/**
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* @warning AVOID calling this method directly if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
|
|
57
|
+
* Cleans up peer state for a closed message port.
|
|
61
58
|
*
|
|
62
|
-
* @param port The message port instance to
|
|
59
|
+
* @param port The same message port instance passed to `.message()`.
|
|
63
60
|
*/
|
|
64
61
|
close(port: SupportedMessagePort): Promise<void>;
|
|
65
62
|
}
|
|
66
63
|
|
|
67
64
|
interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, MessagePortHandlerOptions<T> {
|
|
68
65
|
}
|
|
66
|
+
/**
|
|
67
|
+
* Serves an oRPC router over the RPC protocol on a message port,
|
|
68
|
+
* such as browser extensions, Electron, or worker threads.
|
|
69
|
+
*
|
|
70
|
+
* @see {@link https://orpc.dev/docs/adapters/message-port | Message Port Adapter}
|
|
71
|
+
*/
|
|
69
72
|
declare class RPCHandler<T extends Context> extends MessagePortHandler<T> {
|
|
70
73
|
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
71
74
|
}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { SupportedMessagePort } from '@orpc/client/message-port';
|
|
2
2
|
import { Value, Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import { ServerPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
3
|
+
import { ServerPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
|
|
4
|
+
import { Context } from '../../index.js';
|
|
5
|
+
import { StandardHandler, StandardHandlerOptions } from '../standard/index.js';
|
|
6
|
+
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
|
|
7
|
+
import { Router } from '../../index.js';
|
|
8
|
+
import { RPCHandlerCodecOptions } from '../standard/index.js';
|
|
9
9
|
import '@orpc/client';
|
|
10
10
|
import '@orpc/contract';
|
|
11
|
-
import '@
|
|
11
|
+
import '@standard-server/core';
|
|
12
12
|
|
|
13
13
|
type DecodedResponseMessage = ConstructorParameters<typeof ServerPeer>[0] extends (message: infer TMessage) => unknown ? TMessage : never;
|
|
14
14
|
interface MessagePortHandlerOptions<_T extends Context> {
|
|
@@ -19,9 +19,8 @@ interface MessagePortHandlerOptions<_T extends Context> {
|
|
|
19
19
|
* such as transferring object ownership or supporting non-serializable objects like `OffscreenCanvas` or improving performance.
|
|
20
20
|
*
|
|
21
21
|
* @remarks
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* @warning Ensure your message port implementation supports `transferable` objects before enabling this.
|
|
22
|
+
* **Note**: Returning `null` or `undefined` disables this feature.
|
|
23
|
+
* **Warning**: Ensure your message port implementation supports `transferable` objects before enabling this.
|
|
25
24
|
*/
|
|
26
25
|
experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]>;
|
|
27
26
|
/**
|
|
@@ -41,31 +40,35 @@ declare class MessagePortHandler<T extends Context> {
|
|
|
41
40
|
private readonly decodePeerMessageOptions;
|
|
42
41
|
constructor(handler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
|
|
43
42
|
/**
|
|
44
|
-
* Attaches
|
|
43
|
+
* Attaches message and close listeners to a message port.
|
|
44
|
+
*
|
|
45
|
+
* Prefer this over calling `.message()` and `.close()` manually.
|
|
45
46
|
*/
|
|
46
|
-
upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<
|
|
47
|
+
upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
|
|
47
48
|
/**
|
|
48
49
|
* Handles a single message received from a message port.
|
|
49
50
|
*
|
|
50
|
-
* @
|
|
51
|
-
*
|
|
52
|
-
* @param port The message port instance, require consistent instance across messages for proper peer management
|
|
51
|
+
* @param port The message port instance. Use the same instance for all messages.
|
|
53
52
|
*/
|
|
54
|
-
message(port: SupportedMessagePort, data:
|
|
53
|
+
message(port: SupportedMessagePort, data: unknown, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
|
|
55
54
|
matched: boolean;
|
|
56
55
|
}>;
|
|
57
56
|
/**
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* @warning AVOID calling this method directly if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
|
|
57
|
+
* Cleans up peer state for a closed message port.
|
|
61
58
|
*
|
|
62
|
-
* @param port The message port instance to
|
|
59
|
+
* @param port The same message port instance passed to `.message()`.
|
|
63
60
|
*/
|
|
64
61
|
close(port: SupportedMessagePort): Promise<void>;
|
|
65
62
|
}
|
|
66
63
|
|
|
67
64
|
interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, MessagePortHandlerOptions<T> {
|
|
68
65
|
}
|
|
66
|
+
/**
|
|
67
|
+
* Serves an oRPC router over the RPC protocol on a message port,
|
|
68
|
+
* such as browser extensions, Electron, or worker threads.
|
|
69
|
+
*
|
|
70
|
+
* @see {@link https://orpc.dev/docs/adapters/message-port | Message Port Adapter}
|
|
71
|
+
*/
|
|
69
72
|
declare class RPCHandler<T extends Context> extends MessagePortHandler<T> {
|
|
70
73
|
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
71
74
|
}
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
import { onMessagePortMessage, onMessagePortClose, postMessagePortMessage } from '@orpc/client/message-port';
|
|
2
|
-
import { value,
|
|
3
|
-
import { ServerPeer, encodePeerMessage, decodePeerMessage, isClientPeerSendMessage } from '@
|
|
4
|
-
import {
|
|
5
|
-
import { R as RPCHandlerCodec, S as StandardHandler } from '../../shared/server.
|
|
2
|
+
import { value, resolveMaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { ServerPeer, encodePeerMessage, decodePeerMessage, isClientPeerSendMessage, isPeerMessage } from '@standard-server/peer';
|
|
4
|
+
import { createStandardPeerRequestHandler } from '../standard-peer/index.mjs';
|
|
5
|
+
import { R as RPCHandlerCodec, S as StandardHandler } from '../../shared/server.C0lFtoHU.mjs';
|
|
6
|
+
import '../../shared/server.W91HSRkE.mjs';
|
|
6
7
|
import '@orpc/client';
|
|
7
|
-
import '@
|
|
8
|
-
import '../../shared/server.
|
|
8
|
+
import '@standard-server/core';
|
|
9
|
+
import '../../shared/server.Djb_ebJT.mjs';
|
|
9
10
|
import '@orpc/contract';
|
|
10
|
-
import '../../shared/server.
|
|
11
|
+
import '../../shared/server.BynNaBBA.mjs';
|
|
11
12
|
|
|
12
13
|
class MessagePortHandler {
|
|
13
14
|
constructor(handler, options = {}) {
|
|
@@ -21,7 +22,9 @@ class MessagePortHandler {
|
|
|
21
22
|
encodePeerMessageOptions;
|
|
22
23
|
decodePeerMessageOptions;
|
|
23
24
|
/**
|
|
24
|
-
* Attaches
|
|
25
|
+
* Attaches message and close listeners to a message port.
|
|
26
|
+
*
|
|
27
|
+
* Prefer this over calling `.message()` and `.close()` manually.
|
|
25
28
|
*/
|
|
26
29
|
upgrade(port, ...rest) {
|
|
27
30
|
onMessagePortMessage(port, (message) => this.message(port, message, ...rest));
|
|
@@ -30,51 +33,45 @@ class MessagePortHandler {
|
|
|
30
33
|
/**
|
|
31
34
|
* Handles a single message received from a message port.
|
|
32
35
|
*
|
|
33
|
-
* @
|
|
34
|
-
*
|
|
35
|
-
* @param port The message port instance, require consistent instance across messages for proper peer management
|
|
36
|
+
* @param port The message port instance. Use the same instance for all messages.
|
|
36
37
|
*/
|
|
37
38
|
async message(port, data, ...rest) {
|
|
38
39
|
let peer = this.peers.get(port);
|
|
39
40
|
if (!peer) {
|
|
40
|
-
this.peers.set(port, peer = new ServerPeer(async (
|
|
41
|
-
const transfer = await value(this.transfer,
|
|
41
|
+
this.peers.set(port, peer = new ServerPeer(async (message) => {
|
|
42
|
+
const transfer = await value(this.transfer, message, port);
|
|
42
43
|
if (transfer) {
|
|
43
|
-
postMessagePortMessage(port,
|
|
44
|
+
postMessagePortMessage(port, message, transfer);
|
|
44
45
|
} else {
|
|
45
|
-
postMessagePortMessage(port, await encodePeerMessage(
|
|
46
|
+
postMessagePortMessage(port, await encodePeerMessage(message, this.encodePeerMessageOptions));
|
|
46
47
|
}
|
|
47
48
|
}));
|
|
48
49
|
}
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
50
|
+
let peerMessage;
|
|
51
|
+
if (typeof data === "string" || data instanceof Uint8Array) {
|
|
52
|
+
const result = decodePeerMessage(data, this.decodePeerMessageOptions);
|
|
53
|
+
if (result.matched && isClientPeerSendMessage(result.message)) {
|
|
54
|
+
peerMessage = result.message;
|
|
55
|
+
}
|
|
56
|
+
} else if (isPeerMessage(data) && isClientPeerSendMessage(data)) {
|
|
57
|
+
peerMessage = data;
|
|
55
58
|
}
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
if (result.matched && isClientPeerSendMessage(result.message)) {
|
|
59
|
-
await peer.message(
|
|
60
|
-
result.message,
|
|
61
|
-
createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest))
|
|
62
|
-
);
|
|
59
|
+
if (peerMessage === void 0) {
|
|
60
|
+
return { matched: false };
|
|
63
61
|
}
|
|
64
|
-
|
|
62
|
+
await peer.message(peerMessage, createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest)));
|
|
63
|
+
return { matched: true };
|
|
65
64
|
}
|
|
66
65
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* @warning AVOID calling this method directly if `.upgrade()` is used, as `.upgrade()` already sets up necessary event listeners to call this method for incoming messages and manage peer lifecycle.
|
|
66
|
+
* Cleans up peer state for a closed message port.
|
|
70
67
|
*
|
|
71
|
-
* @param port The message port instance to
|
|
68
|
+
* @param port The same message port instance passed to `.message()`.
|
|
72
69
|
*/
|
|
73
70
|
async close(port) {
|
|
74
71
|
const peer = this.peers.get(port);
|
|
75
72
|
if (peer) {
|
|
76
|
-
await peer.close();
|
|
77
73
|
this.peers.delete(port);
|
|
74
|
+
await peer.close();
|
|
78
75
|
}
|
|
79
76
|
}
|
|
80
77
|
}
|
|
@@ -1,121 +1,44 @@
|
|
|
1
|
-
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
export { R as BodyLimitPlugin } from '../../shared/server.C7xllBNN.mjs';
|
|
2
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
+
import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@standard-server/node';
|
|
4
|
+
import { Context } from '../../index.mjs';
|
|
5
|
+
import { StandardHandler, StandardHandlerOptions } from '../standard/index.mjs';
|
|
5
6
|
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.mjs';
|
|
6
|
-
import
|
|
7
|
-
import {
|
|
8
|
-
import { R as RPCHandlerCodecOptions } from '../../shared/server.Cj5lgPuG.mjs';
|
|
7
|
+
import { Router } from '../../index.mjs';
|
|
8
|
+
import { RPCHandlerCodecOptions } from '../standard/index.mjs';
|
|
9
9
|
import '@orpc/client';
|
|
10
10
|
import '@orpc/contract';
|
|
11
|
-
import '@
|
|
12
|
-
|
|
13
|
-
interface NodeHttpHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
|
14
|
-
/**
|
|
15
|
-
* Initializes the plugin and returns new node HTTP handler options.
|
|
16
|
-
* Called once per plugin instance during composition.
|
|
17
|
-
*
|
|
18
|
-
* This method allows plugins to wrap, extend, or transform node HTTP handler options
|
|
19
|
-
* such as interceptors, or other configuration.
|
|
20
|
-
*
|
|
21
|
-
* @param options - The current handler options from previous plugins or base configuration
|
|
22
|
-
* @returns Transformed handler options with plugin's modifications applied
|
|
23
|
-
*
|
|
24
|
-
* @example
|
|
25
|
-
* ```ts
|
|
26
|
-
* initNodeHttpHandlerOptions(options) {
|
|
27
|
-
* return {
|
|
28
|
-
* ...options,
|
|
29
|
-
* nodeHttpInterceptors: [...(options.nodeHttpInterceptors || []), myInterceptor]
|
|
30
|
-
* }
|
|
31
|
-
* }
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
initNodeHttpHandlerOptions?(options: NodeHttpHandlerOptions<T>): NodeHttpHandlerOptions<T>;
|
|
35
|
-
}
|
|
36
|
-
declare class CompositeNodeHttpHandlerPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
|
|
37
|
-
readonly name = "~composite/node-http-handler";
|
|
38
|
-
protected readonly plugins: NodeHttpHandlerPlugin<T>[];
|
|
39
|
-
constructor(plugins?: NodeHttpHandlerPlugin<T>[]);
|
|
40
|
-
initNodeHttpHandlerOptions(options: NodeHttpHandlerOptions<T>): NodeHttpHandlerOptions<T>;
|
|
41
|
-
}
|
|
11
|
+
import '@standard-server/core';
|
|
42
12
|
|
|
43
13
|
type NodeHttpHandlerHandleResult = {
|
|
44
14
|
matched: true;
|
|
45
15
|
} | {
|
|
46
16
|
matched: false;
|
|
47
17
|
};
|
|
48
|
-
interface
|
|
49
|
-
request: NodeHttpRequest;
|
|
50
|
-
response: NodeHttpResponse;
|
|
51
|
-
sendStandardResponseOptions: SendStandardResponseOptions | undefined;
|
|
52
|
-
}
|
|
53
|
-
type NodeHttpHandlerNodeHttpInterceptor<T extends Context> = Interceptor<NodeHttpHandlerNodeHttpInterceptorOptions<T>, Promise<NodeHttpHandlerHandleResult>>;
|
|
54
|
-
interface NodeHttpHandlerOptions<T extends Context> {
|
|
18
|
+
interface NodeHttpHandlerOptions<_T extends Context> {
|
|
55
19
|
/**
|
|
56
20
|
* Custom options for `sendStandardResponse`, used to send a `Standard Response`
|
|
57
21
|
*/
|
|
58
22
|
sendStandardResponse?: SendStandardResponseOptions | undefined;
|
|
59
|
-
/**
|
|
60
|
-
* Interceptors that run before the mapping between the Standard API and Node HTTP API,
|
|
61
|
-
* useful for extending Node HTTP request/response before handling, ...
|
|
62
|
-
*/
|
|
63
|
-
nodeHttpInterceptors?: NodeHttpHandlerNodeHttpInterceptor<T>[] | undefined;
|
|
64
|
-
plugins?: NodeHttpHandlerPlugin<T>[] | undefined;
|
|
65
23
|
}
|
|
66
24
|
declare class NodeHttpHandler<T extends Context> {
|
|
67
25
|
private readonly standardHandler;
|
|
68
26
|
private readonly sendStandardResponseOptions;
|
|
69
|
-
private readonly nodeHttpInterceptors;
|
|
70
27
|
constructor(standardHandler: StandardHandler<T>, options?: NoInfer<NodeHttpHandlerOptions<T>>);
|
|
71
28
|
handle(request: NodeHttpRequest, response: NodeHttpResponse, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<NodeHttpHandlerHandleResult>;
|
|
72
29
|
}
|
|
73
30
|
|
|
74
|
-
interface
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
}
|
|
83
|
-
declare class BodyCompressionHandlerPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
|
|
84
|
-
name: string;
|
|
85
|
-
private readonly compressionHandler;
|
|
86
|
-
constructor(options?: BodyCompressionHandlerPluginOptions);
|
|
87
|
-
initNodeHttpHandlerOptions(options: NodeHttpHandlerOptions<T>): NodeHttpHandlerOptions<T>;
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
interface BodyLimitHandlerPluginOptions {
|
|
91
|
-
/**
|
|
92
|
-
* The maximum size of the body in bytes.
|
|
93
|
-
*/
|
|
94
|
-
maxBodySize: number;
|
|
95
|
-
}
|
|
96
|
-
declare class BodyLimitHandlerPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
|
|
97
|
-
name: string;
|
|
98
|
-
private readonly maxBodySize;
|
|
99
|
-
constructor(options: BodyLimitHandlerPluginOptions);
|
|
100
|
-
initNodeHttpHandlerOptions(options: NodeHttpHandlerOptions<T>): NodeHttpHandlerOptions<T>;
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
interface RPCHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, RPCHandlerCodecOptions<T> {
|
|
104
|
-
/**
|
|
105
|
-
* Configuration for {@link CSRFGuardHandlerPlugin}, which is enabled by default for `RPCHandler` over HTTP.
|
|
106
|
-
*/
|
|
107
|
-
csrfGuardPlugin?: {
|
|
108
|
-
/**
|
|
109
|
-
* If `false`, this plugin is disabled.
|
|
110
|
-
*
|
|
111
|
-
* @default true
|
|
112
|
-
*/
|
|
113
|
-
enabled?: boolean;
|
|
114
|
-
};
|
|
115
|
-
}
|
|
31
|
+
interface RPCHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, StandardHandlerOptions<T>, RPCHandlerCodecOptions<T> {
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Serves an oRPC router over the RPC protocol using Node.js built-in
|
|
35
|
+
* HTTP request/response objects.
|
|
36
|
+
*
|
|
37
|
+
* @see {@link https://orpc.dev/docs/adapters/node-http | Node HTTP Adapter}
|
|
38
|
+
*/
|
|
116
39
|
declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
|
|
117
40
|
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
118
41
|
}
|
|
119
42
|
|
|
120
|
-
export {
|
|
121
|
-
export type {
|
|
43
|
+
export { NodeHttpHandler, RPCHandler };
|
|
44
|
+
export type { NodeHttpHandlerHandleResult, NodeHttpHandlerOptions, RPCHandlerOptions };
|