@orpc/server 0.0.0-next.f4ed9ab → 0.0.0-next.f5149a8

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.
Files changed (66) hide show
  1. package/README.md +12 -9
  2. package/dist/adapters/aws-lambda/index.d.mts +46 -0
  3. package/dist/adapters/aws-lambda/index.d.ts +46 -0
  4. package/dist/adapters/aws-lambda/index.mjs +42 -0
  5. package/dist/adapters/bun-ws/index.d.mts +12 -11
  6. package/dist/adapters/bun-ws/index.d.ts +12 -11
  7. package/dist/adapters/bun-ws/index.mjs +16 -20
  8. package/dist/adapters/crossws/index.d.mts +8 -5
  9. package/dist/adapters/crossws/index.d.ts +8 -5
  10. package/dist/adapters/crossws/index.mjs +11 -17
  11. package/dist/adapters/fastify/index.d.mts +53 -0
  12. package/dist/adapters/fastify/index.d.ts +53 -0
  13. package/dist/adapters/fastify/index.mjs +54 -0
  14. package/dist/adapters/fetch/index.d.mts +56 -10
  15. package/dist/adapters/fetch/index.d.ts +56 -10
  16. package/dist/adapters/fetch/index.mjs +75 -5
  17. package/dist/adapters/message-port/index.d.mts +57 -0
  18. package/dist/adapters/message-port/index.d.ts +57 -0
  19. package/dist/adapters/message-port/index.mjs +55 -0
  20. package/dist/adapters/node/index.d.mts +33 -11
  21. package/dist/adapters/node/index.d.ts +33 -11
  22. package/dist/adapters/node/index.mjs +71 -14
  23. package/dist/adapters/standard/index.d.mts +8 -13
  24. package/dist/adapters/standard/index.d.ts +8 -13
  25. package/dist/adapters/standard/index.mjs +3 -2
  26. package/dist/adapters/standard-peer/index.d.mts +18 -0
  27. package/dist/adapters/standard-peer/index.d.ts +18 -0
  28. package/dist/adapters/standard-peer/index.mjs +7 -0
  29. package/dist/adapters/websocket/index.d.mts +39 -10
  30. package/dist/adapters/websocket/index.d.ts +39 -10
  31. package/dist/adapters/websocket/index.mjs +49 -20
  32. package/dist/adapters/ws/index.d.mts +11 -8
  33. package/dist/adapters/ws/index.d.ts +11 -8
  34. package/dist/adapters/ws/index.mjs +13 -14
  35. package/dist/helpers/index.d.mts +149 -0
  36. package/dist/helpers/index.d.ts +149 -0
  37. package/dist/helpers/index.mjs +198 -0
  38. package/dist/hibernation/index.d.mts +44 -0
  39. package/dist/hibernation/index.d.ts +44 -0
  40. package/dist/hibernation/index.mjs +65 -0
  41. package/dist/index.d.mts +22 -48
  42. package/dist/index.d.ts +22 -48
  43. package/dist/index.mjs +28 -10
  44. package/dist/plugins/index.d.mts +31 -15
  45. package/dist/plugins/index.d.ts +31 -15
  46. package/dist/plugins/index.mjs +97 -61
  47. package/dist/shared/{server.DPWk5pjW.d.mts → server.B4BGqy3Y.d.mts} +10 -9
  48. package/dist/shared/{server.DPWk5pjW.d.ts → server.B4BGqy3Y.d.ts} +10 -9
  49. package/dist/shared/{server.4FnxLwwr.mjs → server.Bxx6tqNe.mjs} +75 -42
  50. package/dist/shared/server.COL12UTb.d.ts +32 -0
  51. package/dist/shared/server.CVKCo60T.d.mts +12 -0
  52. package/dist/shared/server.Cb6yD7DZ.d.ts +42 -0
  53. package/dist/shared/server.Ck-gOLzq.d.mts +32 -0
  54. package/dist/shared/{server.YZzrREz9.d.ts → server.DBCUJijK.d.mts} +8 -8
  55. package/dist/shared/server.DNtJ-p60.d.ts +12 -0
  56. package/dist/shared/{server.eWLxY3lq.d.mts → server.DPIFWpxG.d.ts} +8 -8
  57. package/dist/shared/{server.BVwwTHyO.mjs → server.DZ5BIITo.mjs} +1 -1
  58. package/dist/shared/{server.DG7Tamti.mjs → server.Ds4HPpvH.mjs} +116 -74
  59. package/dist/shared/server.DzV1hr3z.d.mts +42 -0
  60. package/dist/shared/{server.BW-nUGgA.mjs → server.TEVCLCFC.mjs} +3 -0
  61. package/dist/shared/server.UVMTOWrk.mjs +26 -0
  62. package/package.json +49 -12
  63. package/dist/shared/server.BRoxSiSC.d.mts +0 -12
  64. package/dist/shared/server.BjiJH9Vo.d.ts +0 -10
  65. package/dist/shared/server.Cy1vfSiG.d.ts +0 -12
  66. package/dist/shared/server.QUe9N8P4.d.mts +0 -10
@@ -1,13 +1,14 @@
1
- import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.mjs';
2
- import { Interceptor, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
1
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.mjs';
2
+ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
3
3
  import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
4
- import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.eWLxY3lq.mjs';
5
- import { F as FriendlyStandardHandleOptions } from '../../shared/server.QUe9N8P4.mjs';
6
- import { S as StandardRPCHandlerOptions } from '../../shared/server.BRoxSiSC.mjs';
4
+ import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.DBCUJijK.mjs';
5
+ import { F as FriendlyStandardHandleOptions } from '../../shared/server.CVKCo60T.mjs';
6
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.Ck-gOLzq.mjs';
7
7
  import '@orpc/client';
8
8
  import '@orpc/contract';
9
9
  import '@orpc/standard-server';
10
10
  import '@orpc/client/standard';
11
+ import '../../shared/server.DzV1hr3z.mjs';
11
12
 
12
13
  interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
13
14
  initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
@@ -28,7 +29,7 @@ interface FetchHandlerInterceptorOptions<T extends Context> extends StandardHand
28
29
  toFetchResponseOptions: ToFetchResponseOptions;
29
30
  }
30
31
  interface FetchHandlerOptions<T extends Context> extends ToFetchResponseOptions {
31
- adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, FetchHandleResult, ThrowableError>[];
32
+ adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, Promise<FetchHandleResult>>[];
32
33
  plugins?: FetchHandlerPlugin<T>[];
33
34
  }
34
35
  declare class FetchHandler<T extends Context> {
@@ -56,14 +57,59 @@ declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T
56
57
  initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
57
58
  }
58
59
 
59
- type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
60
+ /**
61
+ * This plugin is heavily inspired by the [Hono Compression Plugin](https://github.com/honojs/hono/blob/main/src/middleware/compress/index.ts)
62
+ */
63
+
64
+ declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
65
+ interface CompressionPluginOptions {
66
+ /**
67
+ * The compression schemes to use for response compression.
68
+ * Schemes are prioritized by their order in this array and
69
+ * only applied if the client supports them.
70
+ *
71
+ * @default ['gzip', 'deflate']
72
+ */
73
+ encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
74
+ /**
75
+ * The minimum response size in bytes required to trigger compression.
76
+ * Responses smaller than this threshold will not be compressed to avoid overhead.
77
+ * If the response size cannot be determined, compression will still be applied.
78
+ *
79
+ * @default 1024 (1KB)
80
+ */
81
+ threshold?: number;
82
+ /**
83
+ * Override the default content-type filter used to determine which responses should be compressed.
84
+ *
85
+ * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
86
+ * @default only responses with compressible content types are compressed.
87
+ */
88
+ filter?: (request: Request, response: Response) => boolean;
89
+ }
90
+ /**
91
+ * The Compression Plugin adds response compression to the Fetch Server.
92
+ * Build on top of [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
93
+ * You might need to polyfill it if your environment does not support it.
94
+ *
95
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
96
+ */
97
+ declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
98
+ private readonly encodings;
99
+ private readonly threshold;
100
+ private readonly filter;
101
+ constructor(options?: CompressionPluginOptions);
102
+ initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
103
+ }
104
+
105
+ interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardRPCHandlerOptions<T>, 'plugins'> {
60
106
  /**
61
107
  * Enables or disables the StrictGetMethodPlugin.
62
108
  *
63
109
  * @default true
64
110
  */
65
111
  strictGetMethodPluginEnabled?: boolean;
66
- };
112
+ }
67
113
  /**
68
114
  * RPC Handler for Fetch Server
69
115
  *
@@ -74,5 +120,5 @@ declare class RPCHandler<T extends Context> extends FetchHandler<T> {
74
120
  constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
75
121
  }
76
122
 
77
- export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
78
- export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
123
+ export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
124
+ export type { BodyLimitPluginOptions, CompressionPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
@@ -1,13 +1,14 @@
1
- import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.js';
2
- import { Interceptor, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
1
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.js';
2
+ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
3
3
  import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
4
- import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.YZzrREz9.js';
5
- import { F as FriendlyStandardHandleOptions } from '../../shared/server.BjiJH9Vo.js';
6
- import { S as StandardRPCHandlerOptions } from '../../shared/server.Cy1vfSiG.js';
4
+ import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.DPIFWpxG.js';
5
+ import { F as FriendlyStandardHandleOptions } from '../../shared/server.DNtJ-p60.js';
6
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.COL12UTb.js';
7
7
  import '@orpc/client';
8
8
  import '@orpc/contract';
9
9
  import '@orpc/standard-server';
10
10
  import '@orpc/client/standard';
11
+ import '../../shared/server.Cb6yD7DZ.js';
11
12
 
12
13
  interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
13
14
  initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
@@ -28,7 +29,7 @@ interface FetchHandlerInterceptorOptions<T extends Context> extends StandardHand
28
29
  toFetchResponseOptions: ToFetchResponseOptions;
29
30
  }
30
31
  interface FetchHandlerOptions<T extends Context> extends ToFetchResponseOptions {
31
- adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, FetchHandleResult, ThrowableError>[];
32
+ adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, Promise<FetchHandleResult>>[];
32
33
  plugins?: FetchHandlerPlugin<T>[];
33
34
  }
34
35
  declare class FetchHandler<T extends Context> {
@@ -56,14 +57,59 @@ declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T
56
57
  initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
57
58
  }
58
59
 
59
- type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
60
+ /**
61
+ * This plugin is heavily inspired by the [Hono Compression Plugin](https://github.com/honojs/hono/blob/main/src/middleware/compress/index.ts)
62
+ */
63
+
64
+ declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
65
+ interface CompressionPluginOptions {
66
+ /**
67
+ * The compression schemes to use for response compression.
68
+ * Schemes are prioritized by their order in this array and
69
+ * only applied if the client supports them.
70
+ *
71
+ * @default ['gzip', 'deflate']
72
+ */
73
+ encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
74
+ /**
75
+ * The minimum response size in bytes required to trigger compression.
76
+ * Responses smaller than this threshold will not be compressed to avoid overhead.
77
+ * If the response size cannot be determined, compression will still be applied.
78
+ *
79
+ * @default 1024 (1KB)
80
+ */
81
+ threshold?: number;
82
+ /**
83
+ * Override the default content-type filter used to determine which responses should be compressed.
84
+ *
85
+ * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
86
+ * @default only responses with compressible content types are compressed.
87
+ */
88
+ filter?: (request: Request, response: Response) => boolean;
89
+ }
90
+ /**
91
+ * The Compression Plugin adds response compression to the Fetch Server.
92
+ * Build on top of [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
93
+ * You might need to polyfill it if your environment does not support it.
94
+ *
95
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
96
+ */
97
+ declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
98
+ private readonly encodings;
99
+ private readonly threshold;
100
+ private readonly filter;
101
+ constructor(options?: CompressionPluginOptions);
102
+ initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
103
+ }
104
+
105
+ interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardRPCHandlerOptions<T>, 'plugins'> {
60
106
  /**
61
107
  * Enables or disables the StrictGetMethodPlugin.
62
108
  *
63
109
  * @default true
64
110
  */
65
111
  strictGetMethodPluginEnabled?: boolean;
66
- };
112
+ }
67
113
  /**
68
114
  * RPC Handler for Fetch Server
69
115
  *
@@ -74,5 +120,5 @@ declare class RPCHandler<T extends Context> extends FetchHandler<T> {
74
120
  constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
75
121
  }
76
122
 
77
- export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
78
- export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
123
+ export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
124
+ export type { BodyLimitPluginOptions, CompressionPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
@@ -1,14 +1,14 @@
1
1
  import { ORPCError } from '@orpc/client';
2
2
  import { toArray, intercept, resolveMaybeOptionalOptions } from '@orpc/shared';
3
3
  import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
4
- import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
4
+ import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
5
5
  import '@orpc/standard-server';
6
6
  import '@orpc/contract';
7
- import { C as CompositeStandardHandlerPlugin, b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
7
+ import { C as CompositeStandardHandlerPlugin, b as StandardRPCHandler } from '../../shared/server.Bxx6tqNe.mjs';
8
8
  import '@orpc/client/standard';
9
9
  import '@orpc/standard-server/batch';
10
- import { S as StrictGetMethodPlugin } from '../../shared/server.BW-nUGgA.mjs';
11
- import '../../shared/server.DG7Tamti.mjs';
10
+ import { S as StrictGetMethodPlugin } from '../../shared/server.TEVCLCFC.mjs';
11
+ import '../../shared/server.Ds4HPpvH.mjs';
12
12
 
13
13
  class BodyLimitPlugin {
14
14
  maxBodySize;
@@ -56,6 +56,76 @@ class BodyLimitPlugin {
56
56
  }
57
57
  }
58
58
 
59
+ const ORDERED_SUPPORTED_ENCODINGS = ["gzip", "deflate"];
60
+ class CompressionPlugin {
61
+ encodings;
62
+ threshold;
63
+ filter;
64
+ constructor(options = {}) {
65
+ this.encodings = options.encodings ?? ORDERED_SUPPORTED_ENCODINGS;
66
+ this.threshold = options.threshold ?? 1024;
67
+ this.filter = (request, response) => {
68
+ const hasContentDisposition = response.headers.has("content-disposition");
69
+ const contentType = response.headers.get("content-type");
70
+ if (!hasContentDisposition && contentType?.startsWith("text/event-stream")) {
71
+ return false;
72
+ }
73
+ return options.filter ? options.filter(request, response) : isCompressibleContentType(contentType);
74
+ };
75
+ }
76
+ initRuntimeAdapter(options) {
77
+ options.adapterInterceptors ??= [];
78
+ options.adapterInterceptors.unshift(async (options2) => {
79
+ const result = await options2.next();
80
+ if (!result.matched) {
81
+ return result;
82
+ }
83
+ const response = result.response;
84
+ if (response.headers.has("content-encoding") || response.headers.has("transfer-encoding") || isNoTransformCacheControl(response.headers.get("cache-control"))) {
85
+ return result;
86
+ }
87
+ const contentLength = response.headers.get("content-length");
88
+ if (contentLength && Number(contentLength) < this.threshold) {
89
+ return result;
90
+ }
91
+ const acceptEncoding = options2.request.headers.get("accept-encoding")?.split(",").map((enc) => enc.trim().split(";")[0]);
92
+ const encoding = this.encodings.find((enc) => acceptEncoding?.includes(enc));
93
+ if (!response.body || encoding === void 0) {
94
+ return result;
95
+ }
96
+ if (!this.filter(options2.request, response)) {
97
+ return result;
98
+ }
99
+ const compressedBody = response.body.pipeThrough(new CompressionStream(encoding));
100
+ const compressedHeaders = new Headers(response.headers);
101
+ compressedHeaders.delete("content-length");
102
+ compressedHeaders.set("content-encoding", encoding);
103
+ return {
104
+ ...result,
105
+ response: new Response(compressedBody, {
106
+ status: response.status,
107
+ statusText: response.statusText,
108
+ headers: compressedHeaders
109
+ })
110
+ };
111
+ });
112
+ }
113
+ }
114
+ 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;
115
+ function isCompressibleContentType(contentType) {
116
+ if (contentType === null) {
117
+ return false;
118
+ }
119
+ return COMPRESSIBLE_CONTENT_TYPE_REGEX.test(contentType);
120
+ }
121
+ const CACHE_CONTROL_NO_TRANSFORM_REGEX = /(?:^|,)\s*no-transform\s*(?:,|$)/i;
122
+ function isNoTransformCacheControl(cacheControl) {
123
+ if (cacheControl === null) {
124
+ return false;
125
+ }
126
+ return CACHE_CONTROL_NO_TRANSFORM_REGEX.test(cacheControl);
127
+ }
128
+
59
129
  class CompositeFetchHandlerPlugin extends CompositeStandardHandlerPlugin {
60
130
  initRuntimeAdapter(options) {
61
131
  for (const plugin of this.plugins) {
@@ -107,4 +177,4 @@ class RPCHandler extends FetchHandler {
107
177
  }
108
178
  }
109
179
 
110
- export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
180
+ export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
@@ -0,0 +1,57 @@
1
+ import { SupportedMessagePort } from '@orpc/client/message-port';
2
+ import { Value, Promisable, MaybeOptionalOptions } from '@orpc/shared';
3
+ import { DecodedResponseMessage } from '@orpc/standard-server-peer';
4
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.mjs';
5
+ import { f as StandardHandler } from '../../shared/server.DBCUJijK.mjs';
6
+ import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.mjs';
7
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.Ck-gOLzq.mjs';
8
+ import '@orpc/client';
9
+ import '@orpc/contract';
10
+ import '@orpc/standard-server';
11
+ import '../../shared/server.CVKCo60T.mjs';
12
+ import '@orpc/client/standard';
13
+ import '../../shared/server.DzV1hr3z.mjs';
14
+
15
+ interface MessagePortHandlerOptions<_T extends Context> {
16
+ /**
17
+ * By default, oRPC serializes request/response messages to string/binary data before sending over message port.
18
+ * If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
19
+ * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
20
+ *
21
+ * @remarks
22
+ * - return null | undefined to disable this feature
23
+ *
24
+ * @warning Make sure your message port supports `transfer` before using this feature.
25
+ * @example
26
+ * ```ts
27
+ * experimental_transfer: (message, port) => {
28
+ * const transfer = deepFindTransferableObjects(message) // implement your own logic
29
+ * return transfer.length ? transfer : null // only enable when needed
30
+ * }
31
+ * ```
32
+ *
33
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
34
+ */
35
+ experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]>;
36
+ }
37
+ declare class MessagePortHandler<T extends Context> {
38
+ private readonly standardHandler;
39
+ private readonly transfer;
40
+ constructor(standardHandler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
41
+ upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): void;
42
+ }
43
+
44
+ interface RPCHandlerOptions<T extends Context> extends StandardRPCHandlerOptions<T>, MessagePortHandlerOptions<T> {
45
+ }
46
+ /**
47
+ * RPC Handler for common message port implementations.
48
+ *
49
+ * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
50
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
51
+ */
52
+ declare class RPCHandler<T extends Context> extends MessagePortHandler<T> {
53
+ constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
54
+ }
55
+
56
+ export { MessagePortHandler, RPCHandler };
57
+ export type { MessagePortHandlerOptions, RPCHandlerOptions };
@@ -0,0 +1,57 @@
1
+ import { SupportedMessagePort } from '@orpc/client/message-port';
2
+ import { Value, Promisable, MaybeOptionalOptions } from '@orpc/shared';
3
+ import { DecodedResponseMessage } from '@orpc/standard-server-peer';
4
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.js';
5
+ import { f as StandardHandler } from '../../shared/server.DPIFWpxG.js';
6
+ import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.js';
7
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.COL12UTb.js';
8
+ import '@orpc/client';
9
+ import '@orpc/contract';
10
+ import '@orpc/standard-server';
11
+ import '../../shared/server.DNtJ-p60.js';
12
+ import '@orpc/client/standard';
13
+ import '../../shared/server.Cb6yD7DZ.js';
14
+
15
+ interface MessagePortHandlerOptions<_T extends Context> {
16
+ /**
17
+ * By default, oRPC serializes request/response messages to string/binary data before sending over message port.
18
+ * If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
19
+ * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
20
+ *
21
+ * @remarks
22
+ * - return null | undefined to disable this feature
23
+ *
24
+ * @warning Make sure your message port supports `transfer` before using this feature.
25
+ * @example
26
+ * ```ts
27
+ * experimental_transfer: (message, port) => {
28
+ * const transfer = deepFindTransferableObjects(message) // implement your own logic
29
+ * return transfer.length ? transfer : null // only enable when needed
30
+ * }
31
+ * ```
32
+ *
33
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
34
+ */
35
+ experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]>;
36
+ }
37
+ declare class MessagePortHandler<T extends Context> {
38
+ private readonly standardHandler;
39
+ private readonly transfer;
40
+ constructor(standardHandler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
41
+ upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): void;
42
+ }
43
+
44
+ interface RPCHandlerOptions<T extends Context> extends StandardRPCHandlerOptions<T>, MessagePortHandlerOptions<T> {
45
+ }
46
+ /**
47
+ * RPC Handler for common message port implementations.
48
+ *
49
+ * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
50
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
51
+ */
52
+ declare class RPCHandler<T extends Context> extends MessagePortHandler<T> {
53
+ constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
54
+ }
55
+
56
+ export { MessagePortHandler, RPCHandler };
57
+ export type { MessagePortHandlerOptions, RPCHandlerOptions };
@@ -0,0 +1,55 @@
1
+ import { postMessagePortMessage, onMessagePortMessage, onMessagePortClose } from '@orpc/client/message-port';
2
+ import { value, resolveMaybeOptionalOptions, isObject } from '@orpc/shared';
3
+ import { experimental_ServerPeerWithoutCodec, serializeResponseMessage, encodeResponseMessage, deserializeRequestMessage, decodeRequestMessage } from '@orpc/standard-server-peer';
4
+ import { c as createServerPeerHandleRequestFn } from '../../shared/server.UVMTOWrk.mjs';
5
+ import '@orpc/client';
6
+ import '@orpc/standard-server';
7
+ import '@orpc/contract';
8
+ import { b as StandardRPCHandler } from '../../shared/server.Bxx6tqNe.mjs';
9
+ import '@orpc/client/standard';
10
+ import '../../shared/server.DZ5BIITo.mjs';
11
+ import '../../shared/server.Ds4HPpvH.mjs';
12
+
13
+ class MessagePortHandler {
14
+ constructor(standardHandler, options = {}) {
15
+ this.standardHandler = standardHandler;
16
+ this.transfer = options.experimental_transfer;
17
+ }
18
+ transfer;
19
+ upgrade(port, ...rest) {
20
+ const peer = new experimental_ServerPeerWithoutCodec(async (message) => {
21
+ const [id, type, payload] = message;
22
+ const transfer = await value(this.transfer, message, port);
23
+ if (transfer) {
24
+ postMessagePortMessage(port, serializeResponseMessage(id, type, payload), transfer);
25
+ } else {
26
+ postMessagePortMessage(port, await encodeResponseMessage(id, type, payload));
27
+ }
28
+ });
29
+ onMessagePortMessage(port, async (message) => {
30
+ const handleFn = createServerPeerHandleRequestFn(this.standardHandler, resolveMaybeOptionalOptions(rest));
31
+ if (isObject(message)) {
32
+ await peer.message(
33
+ deserializeRequestMessage(message),
34
+ handleFn
35
+ );
36
+ } else {
37
+ await peer.message(
38
+ await decodeRequestMessage(message),
39
+ handleFn
40
+ );
41
+ }
42
+ });
43
+ onMessagePortClose(port, () => {
44
+ peer.close();
45
+ });
46
+ }
47
+ }
48
+
49
+ class RPCHandler extends MessagePortHandler {
50
+ constructor(router, options = {}) {
51
+ super(new StandardRPCHandler(router, options), options);
52
+ }
53
+ }
54
+
55
+ export { MessagePortHandler, RPCHandler };
@@ -1,13 +1,15 @@
1
- import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.mjs';
2
- import { Interceptor, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
1
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.mjs';
2
+ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
3
3
  import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@orpc/standard-server-node';
4
- import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.eWLxY3lq.mjs';
5
- import { F as FriendlyStandardHandleOptions } from '../../shared/server.QUe9N8P4.mjs';
6
- import { S as StandardRPCHandlerOptions } from '../../shared/server.BRoxSiSC.mjs';
4
+ import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.DBCUJijK.mjs';
5
+ import { F as FriendlyStandardHandleOptions } from '../../shared/server.CVKCo60T.mjs';
6
+ import compression from '@orpc/interop/compression';
7
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.Ck-gOLzq.mjs';
7
8
  import '@orpc/client';
8
9
  import '@orpc/contract';
9
10
  import '@orpc/standard-server';
10
11
  import '@orpc/client/standard';
12
+ import '../../shared/server.DzV1hr3z.mjs';
11
13
 
12
14
  interface NodeHttpHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
13
15
  initRuntimeAdapter?(options: NodeHttpHandlerOptions<T>): void;
@@ -27,10 +29,10 @@ interface NodeHttpHandlerInterceptorOptions<T extends Context> extends StandardH
27
29
  sendStandardResponseOptions: SendStandardResponseOptions;
28
30
  }
29
31
  interface NodeHttpHandlerOptions<T extends Context> extends SendStandardResponseOptions {
30
- adapterInterceptors?: Interceptor<NodeHttpHandlerInterceptorOptions<T>, NodeHttpHandleResult, ThrowableError>[];
32
+ adapterInterceptors?: Interceptor<NodeHttpHandlerInterceptorOptions<T>, Promise<NodeHttpHandleResult>>[];
31
33
  plugins?: NodeHttpHandlerPlugin<T>[];
32
34
  }
33
- declare class NodeHttpHandler<T extends Context> implements NodeHttpHandler<T> {
35
+ declare class NodeHttpHandler<T extends Context> {
34
36
  private readonly standardHandler;
35
37
  private readonly sendStandardResponseOptions;
36
38
  private readonly adapterInterceptors;
@@ -55,14 +57,34 @@ declare class BodyLimitPlugin<T extends Context> implements NodeHttpHandlerPlugi
55
57
  initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
56
58
  }
57
59
 
58
- type RPCHandlerOptions<T extends Context> = NodeHttpHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
60
+ interface CompressionPluginOptions extends compression.CompressionOptions {
61
+ /**
62
+ * Override the default content-type filter used to determine which responses should be compressed.
63
+ *
64
+ * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
65
+ * @default only responses with compressible content types are compressed.
66
+ */
67
+ filter?: (req: NodeHttpRequest, res: NodeHttpResponse) => boolean;
68
+ }
69
+ /**
70
+ * The Compression Plugin adds response compression to the Node.js HTTP Server.
71
+ *
72
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
73
+ */
74
+ declare class CompressionPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
75
+ private readonly compressionHandler;
76
+ constructor(options?: CompressionPluginOptions);
77
+ initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
78
+ }
79
+
80
+ interface RPCHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardRPCHandlerOptions<T>, 'plugins'> {
59
81
  /**
60
82
  * Enables or disables the StrictGetMethodPlugin.
61
83
  *
62
84
  * @default true
63
85
  */
64
86
  strictGetMethodPluginEnabled?: boolean;
65
- };
87
+ }
66
88
  /**
67
89
  * RPC Handler for Node.js HTTP Server
68
90
  *
@@ -73,5 +95,5 @@ declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
73
95
  constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
74
96
  }
75
97
 
76
- export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, NodeHttpHandler, RPCHandler };
77
- export type { BodyLimitPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };
98
+ export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, CompressionPlugin, NodeHttpHandler, RPCHandler };
99
+ export type { BodyLimitPluginOptions, CompressionPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };
@@ -1,13 +1,15 @@
1
- import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.js';
2
- import { Interceptor, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
1
+ import { C as Context, R as Router } from '../../shared/server.B4BGqy3Y.js';
2
+ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
3
3
  import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@orpc/standard-server-node';
4
- import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.YZzrREz9.js';
5
- import { F as FriendlyStandardHandleOptions } from '../../shared/server.BjiJH9Vo.js';
6
- import { S as StandardRPCHandlerOptions } from '../../shared/server.Cy1vfSiG.js';
4
+ import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.DPIFWpxG.js';
5
+ import { F as FriendlyStandardHandleOptions } from '../../shared/server.DNtJ-p60.js';
6
+ import compression from '@orpc/interop/compression';
7
+ import { S as StandardRPCHandlerOptions } from '../../shared/server.COL12UTb.js';
7
8
  import '@orpc/client';
8
9
  import '@orpc/contract';
9
10
  import '@orpc/standard-server';
10
11
  import '@orpc/client/standard';
12
+ import '../../shared/server.Cb6yD7DZ.js';
11
13
 
12
14
  interface NodeHttpHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
13
15
  initRuntimeAdapter?(options: NodeHttpHandlerOptions<T>): void;
@@ -27,10 +29,10 @@ interface NodeHttpHandlerInterceptorOptions<T extends Context> extends StandardH
27
29
  sendStandardResponseOptions: SendStandardResponseOptions;
28
30
  }
29
31
  interface NodeHttpHandlerOptions<T extends Context> extends SendStandardResponseOptions {
30
- adapterInterceptors?: Interceptor<NodeHttpHandlerInterceptorOptions<T>, NodeHttpHandleResult, ThrowableError>[];
32
+ adapterInterceptors?: Interceptor<NodeHttpHandlerInterceptorOptions<T>, Promise<NodeHttpHandleResult>>[];
31
33
  plugins?: NodeHttpHandlerPlugin<T>[];
32
34
  }
33
- declare class NodeHttpHandler<T extends Context> implements NodeHttpHandler<T> {
35
+ declare class NodeHttpHandler<T extends Context> {
34
36
  private readonly standardHandler;
35
37
  private readonly sendStandardResponseOptions;
36
38
  private readonly adapterInterceptors;
@@ -55,14 +57,34 @@ declare class BodyLimitPlugin<T extends Context> implements NodeHttpHandlerPlugi
55
57
  initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
56
58
  }
57
59
 
58
- type RPCHandlerOptions<T extends Context> = NodeHttpHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
60
+ interface CompressionPluginOptions extends compression.CompressionOptions {
61
+ /**
62
+ * Override the default content-type filter used to determine which responses should be compressed.
63
+ *
64
+ * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
65
+ * @default only responses with compressible content types are compressed.
66
+ */
67
+ filter?: (req: NodeHttpRequest, res: NodeHttpResponse) => boolean;
68
+ }
69
+ /**
70
+ * The Compression Plugin adds response compression to the Node.js HTTP Server.
71
+ *
72
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
73
+ */
74
+ declare class CompressionPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
75
+ private readonly compressionHandler;
76
+ constructor(options?: CompressionPluginOptions);
77
+ initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
78
+ }
79
+
80
+ interface RPCHandlerOptions<T extends Context> extends NodeHttpHandlerOptions<T>, Omit<StandardRPCHandlerOptions<T>, 'plugins'> {
59
81
  /**
60
82
  * Enables or disables the StrictGetMethodPlugin.
61
83
  *
62
84
  * @default true
63
85
  */
64
86
  strictGetMethodPluginEnabled?: boolean;
65
- };
87
+ }
66
88
  /**
67
89
  * RPC Handler for Node.js HTTP Server
68
90
  *
@@ -73,5 +95,5 @@ declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
73
95
  constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
74
96
  }
75
97
 
76
- export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, NodeHttpHandler, RPCHandler };
77
- export type { BodyLimitPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };
98
+ export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, CompressionPlugin, NodeHttpHandler, RPCHandler };
99
+ export type { BodyLimitPluginOptions, CompressionPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };