@orpc/server 2.0.0-beta.5 → 2.0.0-beta.50

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 (171) hide show
  1. package/README.md +137 -102
  2. package/dist/adapters/aws-lambda/handler.d.ts +27 -0
  3. package/dist/adapters/aws-lambda/handler.js +24 -0
  4. package/dist/adapters/aws-lambda/index.d.ts +4 -0
  5. package/dist/adapters/aws-lambda/index.js +2 -0
  6. package/dist/adapters/aws-lambda/rpc-handler.d.ts +19 -0
  7. package/dist/adapters/aws-lambda/rpc-handler.js +21 -0
  8. package/dist/adapters/crossws/handler.d.ts +47 -0
  9. package/dist/adapters/crossws/handler.js +53 -0
  10. package/dist/adapters/crossws/index.d.ts +3 -54
  11. package/dist/adapters/crossws/index.js +2 -0
  12. package/dist/adapters/crossws/rpc-handler.d.ts +16 -0
  13. package/dist/adapters/crossws/rpc-handler.js +18 -0
  14. package/dist/adapters/fastify/handler.d.ts +23 -0
  15. package/dist/adapters/fastify/handler.js +20 -0
  16. package/dist/adapters/fastify/index.d.ts +3 -0
  17. package/dist/adapters/fastify/index.js +2 -0
  18. package/dist/adapters/fastify/rpc-handler.d.ts +15 -0
  19. package/dist/adapters/fastify/rpc-handler.js +17 -0
  20. package/dist/adapters/fetch/handler.d.ts +25 -0
  21. package/dist/adapters/fetch/handler.js +22 -0
  22. package/dist/adapters/fetch/index.d.ts +4 -140
  23. package/dist/adapters/fetch/index.js +3 -0
  24. package/dist/adapters/fetch/rpc-handler.d.ts +17 -0
  25. package/dist/adapters/fetch/rpc-handler.js +19 -0
  26. package/dist/adapters/message-port/handler.d.ts +62 -0
  27. package/dist/adapters/message-port/handler.js +72 -0
  28. package/dist/adapters/message-port/index.d.ts +3 -74
  29. package/dist/adapters/message-port/index.js +2 -0
  30. package/dist/adapters/message-port/rpc-handler.d.ts +16 -0
  31. package/dist/adapters/message-port/rpc-handler.js +18 -0
  32. package/dist/adapters/node/handler.d.ts +23 -0
  33. package/dist/adapters/node/handler.js +20 -0
  34. package/dist/adapters/node/index.d.ts +4 -121
  35. package/dist/adapters/node/index.js +3 -0
  36. package/dist/adapters/node/rpc-handler.d.ts +16 -0
  37. package/dist/adapters/node/rpc-handler.js +18 -0
  38. package/dist/adapters/standard/codec.d.ts +16 -0
  39. package/dist/adapters/standard/handler.d.ts +68 -0
  40. package/dist/adapters/standard/handler.js +205 -0
  41. package/dist/adapters/standard/index.d.ts +7 -19
  42. package/dist/adapters/standard/index.js +4 -0
  43. package/dist/adapters/standard/plugin.d.ts +26 -0
  44. package/dist/adapters/standard/plugin.js +14 -0
  45. package/dist/adapters/standard/rpc-handler-codec.d.ts +42 -0
  46. package/dist/adapters/standard/rpc-handler-codec.js +50 -0
  47. package/dist/adapters/standard/rpc-matcher.d.ts +53 -0
  48. package/dist/adapters/standard/rpc-matcher.js +106 -0
  49. package/dist/adapters/standard/utils.d.ts +10 -0
  50. package/dist/adapters/standard/utils.js +8 -0
  51. package/dist/adapters/standard-peer/index.d.ts +2 -16
  52. package/dist/adapters/standard-peer/index.js +1 -0
  53. package/dist/adapters/standard-peer/utils.d.ts +6 -0
  54. package/dist/adapters/standard-peer/utils.js +13 -0
  55. package/dist/adapters/websocket/handler.d.ts +61 -0
  56. package/dist/adapters/websocket/handler.js +75 -0
  57. package/dist/adapters/websocket/index.d.ts +3 -61
  58. package/dist/adapters/websocket/index.js +2 -0
  59. package/dist/adapters/websocket/rpc-handler.d.ts +16 -0
  60. package/dist/adapters/websocket/rpc-handler.js +18 -0
  61. package/dist/builder-variants.d.ts +226 -0
  62. package/dist/builder.d.ts +126 -0
  63. package/dist/builder.js +200 -0
  64. package/dist/constants.d.ts +2 -0
  65. package/dist/constants.js +4 -0
  66. package/dist/context.d.ts +6 -0
  67. package/dist/extensions/callable.d.ts +11 -10
  68. package/dist/extensions/callable.js +8 -0
  69. package/dist/helpers/base64url.d.ts +31 -0
  70. package/dist/helpers/base64url.js +48 -0
  71. package/dist/helpers/cookie.d.ts +50 -0
  72. package/dist/helpers/cookie.js +62 -0
  73. package/dist/helpers/encryption.d.ts +28 -0
  74. package/dist/helpers/encryption.js +90 -0
  75. package/dist/helpers/index.d.ts +5 -149
  76. package/dist/helpers/index.js +4 -0
  77. package/dist/helpers/signing.d.ts +50 -0
  78. package/dist/helpers/signing.js +78 -0
  79. package/dist/implementer-procedure.d.ts +15 -0
  80. package/dist/implementer-procedure.js +37 -0
  81. package/dist/implementer-router.d.ts +34 -0
  82. package/dist/implementer-router.js +98 -0
  83. package/dist/implementer.d.ts +16 -0
  84. package/dist/implementer.js +30 -0
  85. package/dist/index.d.ts +22 -196
  86. package/dist/index.js +16 -0
  87. package/dist/lazy.d.ts +20 -0
  88. package/dist/lazy.js +20 -0
  89. package/dist/middleware-decorated.d.ts +9 -0
  90. package/dist/middleware-decorated.js +67 -0
  91. package/dist/middleware.d.ts +54 -0
  92. package/dist/plugins/batch.d.ts +102 -0
  93. package/dist/plugins/batch.js +371 -0
  94. package/dist/plugins/cors.d.ts +69 -0
  95. package/dist/plugins/cors.js +119 -0
  96. package/dist/plugins/get-method-csrf-protection.d.ts +25 -0
  97. package/dist/plugins/get-method-csrf-protection.js +48 -0
  98. package/dist/plugins/head-method.d.ts +25 -0
  99. package/dist/plugins/head-method.js +107 -0
  100. package/dist/plugins/index.d.ts +15 -197
  101. package/dist/plugins/index.js +14 -0
  102. package/dist/plugins/method-override.d.ts +40 -0
  103. package/dist/plugins/method-override.js +54 -0
  104. package/dist/plugins/request-compression.d.ts +18 -0
  105. package/dist/plugins/request-compression.js +55 -0
  106. package/dist/plugins/request-headers.d.ts +24 -0
  107. package/dist/plugins/request-headers.js +28 -0
  108. package/dist/plugins/request-limit.d.ts +32 -0
  109. package/dist/plugins/request-limit.js +61 -0
  110. package/dist/plugins/response-compression.d.ts +62 -0
  111. package/dist/plugins/response-compression.js +157 -0
  112. package/dist/plugins/response-headers.d.ts +32 -0
  113. package/dist/plugins/response-headers.js +44 -0
  114. package/dist/plugins/rethrow.d.ts +35 -0
  115. package/dist/plugins/rethrow.js +47 -0
  116. package/dist/plugins/signal-sync.d.ts +15 -0
  117. package/dist/plugins/signal-sync.js +76 -0
  118. package/dist/plugins/timeout.d.ts +39 -0
  119. package/dist/plugins/timeout.js +62 -0
  120. package/dist/procedure-client.d.ts +18 -0
  121. package/dist/procedure-client.js +158 -0
  122. package/dist/procedure-decorated.d.ts +10 -0
  123. package/dist/procedure-decorated.js +36 -0
  124. package/dist/procedure-utils.d.ts +21 -0
  125. package/dist/procedure-utils.js +48 -0
  126. package/dist/procedure.d.ts +72 -0
  127. package/dist/procedure.js +18 -0
  128. package/dist/router-client.d.ts +21 -0
  129. package/dist/router-client.js +35 -0
  130. package/dist/router-hidden.js +12 -0
  131. package/dist/router-utils.d.ts +31 -0
  132. package/dist/router-utils.js +157 -0
  133. package/dist/router.d.ts +58 -0
  134. package/package.json +95 -63
  135. package/dist/adapters/crossws/index.d.mts +0 -54
  136. package/dist/adapters/crossws/index.mjs +0 -64
  137. package/dist/adapters/fetch/index.d.mts +0 -140
  138. package/dist/adapters/fetch/index.mjs +0 -204
  139. package/dist/adapters/message-port/index.d.mts +0 -74
  140. package/dist/adapters/message-port/index.mjs +0 -90
  141. package/dist/adapters/node/index.d.mts +0 -121
  142. package/dist/adapters/node/index.mjs +0 -179
  143. package/dist/adapters/standard/index.d.mts +0 -19
  144. package/dist/adapters/standard/index.mjs +0 -8
  145. package/dist/adapters/standard-peer/index.d.mts +0 -16
  146. package/dist/adapters/standard-peer/index.mjs +0 -2
  147. package/dist/adapters/websocket/index.d.mts +0 -61
  148. package/dist/adapters/websocket/index.mjs +0 -76
  149. package/dist/extensions/callable.d.mts +0 -10
  150. package/dist/extensions/callable.mjs +0 -11
  151. package/dist/helpers/index.d.mts +0 -149
  152. package/dist/helpers/index.mjs +0 -198
  153. package/dist/index.d.mts +0 -196
  154. package/dist/index.mjs +0 -385
  155. package/dist/plugins/index.d.mts +0 -197
  156. package/dist/plugins/index.mjs +0 -357
  157. package/dist/shared/server.BL22TloH.d.mts +0 -184
  158. package/dist/shared/server.BL22TloH.d.ts +0 -184
  159. package/dist/shared/server.BsNNjG5J.d.mts +0 -61
  160. package/dist/shared/server.BwHnWUuN.mjs +0 -222
  161. package/dist/shared/server.CX4vUnDk.mjs +0 -11
  162. package/dist/shared/server.Cj5lgPuG.d.mts +0 -66
  163. package/dist/shared/server.CjOb6ItT.mjs +0 -41
  164. package/dist/shared/server.CrlKQucM.mjs +0 -233
  165. package/dist/shared/server.DBANIheG.d.ts +0 -104
  166. package/dist/shared/server.DJIkub_t.d.mts +0 -104
  167. package/dist/shared/server.D_QauotT.mjs +0 -30
  168. package/dist/shared/server.GDpX6Df8.mjs +0 -271
  169. package/dist/shared/server.Pa0F03f_.d.ts +0 -61
  170. package/dist/shared/server.W91HSRkE.mjs +0 -9
  171. package/dist/shared/server.d_2NS3g5.d.ts +0 -66
@@ -0,0 +1,53 @@
1
+ import { createStandardPeerRequestHandler } from "../standard-peer/utils.js";
2
+ import { resolveMaybeOptionalOptions } from "@orpc/shared";
3
+ import { ServerPeer, decodePeerMessage, encodePeerMessage, isClientPeerSendMessage } from "@standard-server/peer";
4
+ // src/adapters/crossws/handler.ts
5
+ var experimental_CrosswsHandler = class {
6
+ handler;
7
+ /**
8
+ * `null` marks a closed peer, so late messages never create a new server peer.
9
+ */
10
+ peers = /* @__PURE__ */ new WeakMap();
11
+ encodePeerMessageOptions;
12
+ decodePeerMessageOptions;
13
+ constructor(handler, options = {}) {
14
+ this.handler = handler;
15
+ this.encodePeerMessageOptions = options.encodePeerMessage;
16
+ this.decodePeerMessageOptions = options.decodePeerMessage;
17
+ }
18
+ /**
19
+ * Handles a single WebSocket message.
20
+ *
21
+ * Message order matters. Call this immediately after receiving a message,
22
+ * before any other async work, to preserve ordering.
23
+ *
24
+ * @param ws The crossws peer instance. Use the same instance for all messages.
25
+ */
26
+ async message(ws, message, ...rest) {
27
+ /**
28
+ * Message order is important: loading -> decode -> .message.
29
+ * This flow must stay synchronous, or we need to use `sequential` helper
30
+ */
31
+ const encodedMessage = typeof message.rawData === "string" ? message.rawData : message.uint8Array();
32
+ const result = decodePeerMessage(encodedMessage, this.decodePeerMessageOptions);
33
+ let peer = this.peers.get(ws);
34
+ if (peer === null) return result;
35
+ if (!peer) this.peers.set(ws, peer = new ServerPeer(async (message) => {
36
+ ws.send(await encodePeerMessage(message, this.encodePeerMessageOptions));
37
+ }));
38
+ if (result.matched && isClientPeerSendMessage(result.message)) await peer.message(result.message, createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest)));
39
+ return result;
40
+ }
41
+ /**
42
+ * Cleans up peer state for a closed WebSocket.
43
+ * Messages passed to `.message()` for this peer afterwards are ignored.
44
+ *
45
+ * @param ws The same crossws peer instance passed to `.message()`.
46
+ */
47
+ async close(ws) {
48
+ const peer = this.peers.get(ws);
49
+ this.peers.set(ws, null);
50
+ await peer?.close();
51
+ }
52
+ };
53
+ export { experimental_CrosswsHandler };
@@ -1,54 +1,3 @@
1
- import { MaybeOptionalOptions } from '@orpc/shared';
2
- import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
3
- import { Message, Peer } from 'crossws';
4
- import { C as Context } from '../../shared/server.BL22TloH.js';
5
- import { S as StandardHandler, a as StandardHandlerOptions } from '../../shared/server.DBANIheG.js';
6
- import { StandardPeerRequestHandlerOptions } from '../standard-peer/index.js';
7
- import { R as Router } from '../../shared/server.Pa0F03f_.js';
8
- import { R as RPCHandlerCodecOptions } from '../../shared/server.d_2NS3g5.js';
9
- import '@orpc/client';
10
- import '@orpc/contract';
11
- import '@standardserver/core';
12
-
13
- type CrosswsPeerLike = Pick<Peer, 'send'>;
14
- type CrosswsMessageLike = Pick<Message, 'rawData' | 'uint8Array'>;
15
- interface experimental_CrosswsHandlerOptions<_T extends Context> {
16
- /**
17
- * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
18
- */
19
- encodePeerMessage?: EncodePeerMessageOptions | undefined;
20
- /**
21
- * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
22
- */
23
- decodePeerMessage?: DecodePeerMessageOptions | undefined;
24
- }
25
- declare class experimental_CrosswsHandler<T extends Context> {
26
- private readonly handler;
27
- private readonly peers;
28
- private readonly encodePeerMessageOptions;
29
- private readonly decodePeerMessageOptions;
30
- constructor(handler: StandardHandler<T>, options?: NoInfer<experimental_CrosswsHandlerOptions<T>>);
31
- /**
32
- * Handles a single message received from a crossws Peer.
33
- *
34
- * @param ws The crossws Peer instance, require consistent instance across messages for proper peer management
35
- */
36
- message(ws: CrosswsPeerLike, message: CrosswsMessageLike, ...rest: MaybeOptionalOptions<StandardPeerRequestHandlerOptions<T>>): Promise<{
37
- matched: boolean;
38
- }>;
39
- /**
40
- * Closes the peer connection and cleans up associated resources.
41
- *
42
- * @param ws The crossws Peer instance to close, require consistent instance for proper peer management
43
- */
44
- close(ws: CrosswsPeerLike): Promise<void>;
45
- }
46
-
47
- interface experimental_RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, experimental_CrosswsHandlerOptions<T> {
48
- }
49
- declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
50
- constructor(router: Router<T>, options?: NoInfer<experimental_RPCHandlerOptions<T>>);
51
- }
52
-
53
- export { experimental_CrosswsHandler, experimental_RPCHandler };
54
- export type { CrosswsMessageLike, CrosswsPeerLike, experimental_CrosswsHandlerOptions, experimental_RPCHandlerOptions };
1
+ import { CrosswsMessageLike, CrosswsPeerLike, experimental_CrosswsHandler, experimental_CrosswsHandlerOptions } from "./handler.js";
2
+ import { experimental_RPCHandler, experimental_RPCHandlerOptions } from "./rpc-handler.js";
3
+ export { CrosswsMessageLike, CrosswsPeerLike, experimental_CrosswsHandler, experimental_CrosswsHandlerOptions, experimental_RPCHandler, experimental_RPCHandlerOptions };
@@ -0,0 +1,2 @@
1
+ export { experimental_CrosswsHandler } from "./handler.js";
2
+ export { experimental_RPCHandler } from "./rpc-handler.js";
@@ -0,0 +1,16 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandlerOptions } from "../standard/handler.js";
3
+ import { Router } from "../../router.js";
4
+ import { RPCHandlerCodecOptions } from "../standard/rpc-handler-codec.js";
5
+ import "../standard/index.js";
6
+ import { experimental_CrosswsHandler, experimental_CrosswsHandlerOptions } from "./handler.js";
7
+ export interface experimental_RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, experimental_CrosswsHandlerOptions<T> {}
8
+ /**
9
+ * Serves an oRPC router over the RPC protocol on a WebSocket connection
10
+ * managed by [crossws](https://github.com/h3js/crossws).
11
+ *
12
+ * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
13
+ */
14
+ export declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
15
+ constructor(router: Router<T>, options?: NoInfer<experimental_RPCHandlerOptions<T>>);
16
+ }
@@ -0,0 +1,18 @@
1
+ import { RPCHandlerCodec } from "../standard/rpc-handler-codec.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { experimental_CrosswsHandler } from "./handler.js";
4
+ // src/adapters/crossws/rpc-handler.ts
5
+ /**
6
+ * Serves an oRPC router over the RPC protocol on a WebSocket connection
7
+ * managed by [crossws](https://github.com/h3js/crossws).
8
+ *
9
+ * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
10
+ */
11
+ var experimental_RPCHandler = class extends experimental_CrosswsHandler {
12
+ constructor(router, options = {}) {
13
+ const codec = new RPCHandlerCodec(router, options);
14
+ const handler = new StandardHandler(codec, options);
15
+ super(handler, options);
16
+ }
17
+ };
18
+ export { experimental_RPCHandler };
@@ -0,0 +1,23 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { FriendlyStandardHandlerHandleOptions } from "../standard/utils.js";
4
+ import "../standard/index.js";
5
+ import { MaybeOptionalOptions } from "@orpc/shared";
6
+ import { AnyFastifyReply, AnyFastifyRequest, SendStandardResponseOptions } from "@standard-server/fastify";
7
+ export type FastifyHandlerHandleResult = {
8
+ matched: true;
9
+ } | {
10
+ matched: false;
11
+ };
12
+ export interface FastifyHandlerOptions<_T extends Context> {
13
+ /**
14
+ * Custom options for `sendStandardResponse`, used to send a `Standard Response`
15
+ */
16
+ sendStandardResponse?: SendStandardResponseOptions | undefined;
17
+ }
18
+ export declare class FastifyHandler<T extends Context> {
19
+ private readonly standardHandler;
20
+ private readonly sendStandardResponseOptions;
21
+ constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FastifyHandlerOptions<T>>);
22
+ handle(request: AnyFastifyRequest, reply: AnyFastifyReply, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<FastifyHandlerHandleResult>;
23
+ }
@@ -0,0 +1,20 @@
1
+ import { resolveFriendlyStandardHandlerHandleOptions } from "../standard/utils.js";
2
+ import { resolveMaybeOptionalOptions } from "@orpc/shared";
3
+ import { sendStandardResponse, toStandardLazyRequest } from "@standard-server/fastify";
4
+ // src/adapters/fastify/handler.ts
5
+ var FastifyHandler = class {
6
+ standardHandler;
7
+ sendStandardResponseOptions;
8
+ constructor(standardHandler, options = {}) {
9
+ this.standardHandler = standardHandler;
10
+ this.sendStandardResponseOptions = options.sendStandardResponse;
11
+ }
12
+ async handle(request, reply, ...rest) {
13
+ const standardRequest = toStandardLazyRequest(request, reply);
14
+ const result = await this.standardHandler.handle(standardRequest, resolveFriendlyStandardHandlerHandleOptions(resolveMaybeOptionalOptions(rest)));
15
+ if (!result.matched) return result;
16
+ await sendStandardResponse(reply, result.response, this.sendStandardResponseOptions);
17
+ return result;
18
+ }
19
+ };
20
+ export { FastifyHandler };
@@ -0,0 +1,3 @@
1
+ import { FastifyHandler, FastifyHandlerHandleResult, FastifyHandlerOptions } from "./handler.js";
2
+ import { RPCHandler, RPCHandlerOptions } from "./rpc-handler.js";
3
+ export { FastifyHandler, FastifyHandlerHandleResult, FastifyHandlerOptions, RPCHandler, RPCHandlerOptions };
@@ -0,0 +1,2 @@
1
+ export { FastifyHandler } from "./handler.js";
2
+ export { RPCHandler } from "./rpc-handler.js";
@@ -0,0 +1,15 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandlerOptions } from "../standard/handler.js";
3
+ import { Router } from "../../router.js";
4
+ import { RPCHandlerCodecOptions } from "../standard/rpc-handler-codec.js";
5
+ import "../standard/index.js";
6
+ import { FastifyHandler, FastifyHandlerOptions } from "./handler.js";
7
+ export interface RPCHandlerOptions<T extends Context> extends FastifyHandlerOptions<T>, StandardHandlerOptions<T>, RPCHandlerCodecOptions<T> {}
8
+ /**
9
+ * Serves an oRPC router over the RPC protocol inside a Fastify server.
10
+ *
11
+ * @see {@link https://orpc.dev/docs/adapters/fastify | Fastify Adapter}
12
+ */
13
+ export declare class RPCHandler<T extends Context> extends FastifyHandler<T> {
14
+ constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
15
+ }
@@ -0,0 +1,17 @@
1
+ import { RPCHandlerCodec } from "../standard/rpc-handler-codec.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { FastifyHandler } from "./handler.js";
4
+ // src/adapters/fastify/rpc-handler.ts
5
+ /**
6
+ * Serves an oRPC router over the RPC protocol inside a Fastify server.
7
+ *
8
+ * @see {@link https://orpc.dev/docs/adapters/fastify | Fastify Adapter}
9
+ */
10
+ var RPCHandler = class extends FastifyHandler {
11
+ constructor(router, options = {}) {
12
+ const codec = new RPCHandlerCodec(router, options);
13
+ const handler = new StandardHandler(codec, options);
14
+ super(handler, options);
15
+ }
16
+ };
17
+ export { RPCHandler };
@@ -0,0 +1,25 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { FriendlyStandardHandlerHandleOptions } from "../standard/utils.js";
4
+ import "../standard/index.js";
5
+ import { MaybeOptionalOptions } from "@orpc/shared";
6
+ import { ToFetchResponseOptions } from "@standard-server/fetch";
7
+ export type FetchHandlerHandleResult = {
8
+ matched: true;
9
+ response: Response;
10
+ } | {
11
+ matched: false;
12
+ response?: undefined;
13
+ };
14
+ export interface FetchHandlerOptions<_T extends Context> {
15
+ /**
16
+ * Options for how to convert the Fetch Response to a Standard Response, like event stream options, etc.
17
+ */
18
+ toFetchResponse?: ToFetchResponseOptions | undefined;
19
+ }
20
+ export declare class FetchHandler<T extends Context> {
21
+ private readonly standardHandler;
22
+ private readonly toFetchResponseOptions;
23
+ constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
24
+ handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<FetchHandlerHandleResult>;
25
+ }
@@ -0,0 +1,22 @@
1
+ import { resolveFriendlyStandardHandlerHandleOptions } from "../standard/utils.js";
2
+ import { resolveMaybeOptionalOptions } from "@orpc/shared";
3
+ import { toFetchResponse, toStandardLazyRequest } from "@standard-server/fetch";
4
+ // src/adapters/fetch/handler.ts
5
+ var FetchHandler = class {
6
+ standardHandler;
7
+ toFetchResponseOptions;
8
+ constructor(standardHandler, options = {}) {
9
+ this.standardHandler = standardHandler;
10
+ this.toFetchResponseOptions = options.toFetchResponse;
11
+ }
12
+ async handle(request, ...rest) {
13
+ const standardRequest = toStandardLazyRequest(request);
14
+ const result = await this.standardHandler.handle(standardRequest, resolveFriendlyStandardHandlerHandleOptions(resolveMaybeOptionalOptions(rest)));
15
+ if (!result.matched) return result;
16
+ return {
17
+ matched: true,
18
+ response: toFetchResponse(result.response, this.toFetchResponseOptions)
19
+ };
20
+ }
21
+ };
22
+ export { FetchHandler };
@@ -1,140 +1,4 @@
1
- import { C as Context } from '../../shared/server.BL22TloH.js';
2
- import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
3
- import { ToFetchResponseOptions } from '@standardserver/fetch';
4
- import { e as StandardHandlerPlugin, b as StandardHandlerHandleOptions, S as StandardHandler, a as StandardHandlerOptions } from '../../shared/server.DBANIheG.js';
5
- import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
6
- import { R as Router } from '../../shared/server.Pa0F03f_.js';
7
- import { R as RPCHandlerCodecOptions } from '../../shared/server.d_2NS3g5.js';
8
- import '@orpc/client';
9
- import '@orpc/contract';
10
- import '@standardserver/core';
11
-
12
- interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
13
- /**
14
- * Initializes the plugin and returns new fetch handler options.
15
- * Called once per plugin instance during composition.
16
- *
17
- * This method allows plugins to wrap, extend, or transform fetch handler options
18
- * such as fetch interceptors, or fetch configuration.
19
- *
20
- * @param options - The current handler options from previous plugins or base configuration
21
- * @returns Transformed handler options with plugin's modifications applied
22
- *
23
- * @example
24
- * ```ts
25
- * initFetchHandlerOptions(options) {
26
- * return {
27
- * ...options,
28
- * interceptors: [...(options.interceptors || []), myInterceptor]
29
- * }
30
- * }
31
- * ```
32
- */
33
- initFetchHandlerOptions?(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
34
- }
35
- declare class CompositeFetchHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
36
- readonly name = "~composite/fetch-handler";
37
- protected readonly plugins: FetchHandlerPlugin<T>[];
38
- constructor(plugins?: FetchHandlerPlugin<T>[]);
39
- initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
40
- }
41
-
42
- type FetchHandlerHandleResult = {
43
- matched: true;
44
- response: Response;
45
- } | {
46
- matched: false;
47
- response?: undefined;
48
- };
49
- interface FetchHandlerFetchInterceptorOptions<T extends Context> extends StandardHandlerHandleOptions<T> {
50
- request: Request;
51
- toFetchResponseOptions: ToFetchResponseOptions | undefined;
52
- }
53
- type FetchHandlerFetchInterceptor<T extends Context> = Interceptor<FetchHandlerFetchInterceptorOptions<T>, Promise<FetchHandlerHandleResult>>;
54
- interface FetchHandlerOptions<T extends Context> {
55
- /**
56
- * Options for how to convert the Fetch Response to a Standard Response, like event iterator options, etc.
57
- */
58
- toFetchResponse?: undefined | ToFetchResponseOptions;
59
- /**
60
- * Interceptors that run before the mapping between the Standard API and Fetch API,
61
- * useful for customizing the mapping behavior (e.g. extending the body parser).
62
- */
63
- fetchInterceptors?: FetchHandlerFetchInterceptor<T>[] | undefined;
64
- plugins?: FetchHandlerPlugin<T>[] | undefined;
65
- }
66
- declare class FetchHandler<T extends Context> {
67
- private readonly standardHandler;
68
- private readonly toFetchResponseOptions;
69
- private readonly fetchInterceptors;
70
- constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
71
- handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<FetchHandlerHandleResult>;
72
- }
73
-
74
- declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
75
- interface BodyCompressionHandlerPluginOptions {
76
- /**
77
- * The compression schemes to use for response compression.
78
- * Schemes are prioritized by their order in this array and
79
- * only applied if the client supports them.
80
- *
81
- * @default ['gzip', 'deflate']
82
- */
83
- encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
84
- /**
85
- * The minimum response size in bytes required to trigger compression.
86
- * Responses smaller than this threshold will not be compressed to avoid overhead.
87
- * If the response size cannot be determined, compression will still be applied.
88
- *
89
- * @default 1024 (1KB)
90
- */
91
- threshold?: number;
92
- /**
93
- * Override the default content-type filter used to determine which responses should be compressed.
94
- *
95
- * @warning Event stream responses are never compressed, regardless of this filter's return value.
96
- * @default only responses with compressible content types are compressed.
97
- */
98
- filter?: (request: Request, response: Response) => boolean;
99
- }
100
- declare class BodyCompressionHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
101
- name: string;
102
- private readonly encodings;
103
- private readonly threshold;
104
- private readonly filter;
105
- constructor(options?: BodyCompressionHandlerPluginOptions);
106
- initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
107
- }
108
-
109
- interface BodyLimitHandlerPluginOptions {
110
- /**
111
- * The maximum size of the body in bytes.
112
- */
113
- maxBodySize: number;
114
- }
115
- declare class BodyLimitHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
116
- name: string;
117
- private readonly maxBodySize;
118
- constructor(options: BodyLimitHandlerPluginOptions);
119
- initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
120
- }
121
-
122
- interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, RPCHandlerCodecOptions<T> {
123
- /**
124
- * Configuration for {@link CSRFGuardHandlerPlugin}, which is enabled by default for `RPCHandler` over HTTP.
125
- */
126
- csrfGuardHandlerPlugin?: {
127
- /**
128
- * If `false`, this plugin is disabled.
129
- *
130
- * @default true
131
- */
132
- enabled?: boolean;
133
- };
134
- }
135
- declare class RPCHandler<T extends Context> extends FetchHandler<T> {
136
- constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
137
- }
138
-
139
- export { BodyCompressionHandlerPlugin, BodyLimitHandlerPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
140
- export type { BodyCompressionHandlerPluginOptions, BodyLimitHandlerPluginOptions, FetchHandlerFetchInterceptor, FetchHandlerFetchInterceptorOptions, FetchHandlerHandleResult, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
1
+ import { RequestLimitHandlerPlugin } from "../../plugins/request-limit.js";
2
+ import { FetchHandler, FetchHandlerHandleResult, FetchHandlerOptions } from "./handler.js";
3
+ import { RPCHandler, RPCHandlerOptions } from "./rpc-handler.js";
4
+ export { RequestLimitHandlerPlugin as BodyLimitPlugin, FetchHandler, FetchHandlerHandleResult, FetchHandlerOptions, RPCHandler, RPCHandlerOptions };
@@ -0,0 +1,3 @@
1
+ export { RequestLimitHandlerPlugin as BodyLimitPlugin } from "../../plugins/request-limit.js";
2
+ export { FetchHandler } from "./handler.js";
3
+ export { RPCHandler } from "./rpc-handler.js";
@@ -0,0 +1,17 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandlerOptions } from "../standard/handler.js";
3
+ import { Router } from "../../router.js";
4
+ import { RPCHandlerCodecOptions } from "../standard/rpc-handler-codec.js";
5
+ import "../standard/index.js";
6
+ import { FetchHandler, FetchHandlerOptions } from "./handler.js";
7
+ export interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, StandardHandlerOptions<T>, RPCHandlerCodecOptions<T> {}
8
+ /**
9
+ * Serves an oRPC router over the RPC protocol using the Fetch API
10
+ * (Request/Response), supported by modern runtimes like Deno, Bun,
11
+ * Cloudflare Workers, and browsers.
12
+ *
13
+ * @see {@link https://orpc.dev/docs/adapters/fetch-api | Fetch API Adapter}
14
+ */
15
+ export declare class RPCHandler<T extends Context> extends FetchHandler<T> {
16
+ constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
17
+ }
@@ -0,0 +1,19 @@
1
+ import { RPCHandlerCodec } from "../standard/rpc-handler-codec.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { FetchHandler } from "./handler.js";
4
+ // src/adapters/fetch/rpc-handler.ts
5
+ /**
6
+ * Serves an oRPC router over the RPC protocol using the Fetch API
7
+ * (Request/Response), supported by modern runtimes like Deno, Bun,
8
+ * Cloudflare Workers, and browsers.
9
+ *
10
+ * @see {@link https://orpc.dev/docs/adapters/fetch-api | Fetch API Adapter}
11
+ */
12
+ var RPCHandler = class extends FetchHandler {
13
+ constructor(router, options = {}) {
14
+ const codec = new RPCHandlerCodec(router, options);
15
+ const handler = new StandardHandler(codec, options);
16
+ super(handler, options);
17
+ }
18
+ };
19
+ export { RPCHandler };
@@ -0,0 +1,62 @@
1
+ import { Context } from "../../context.js";
2
+ import { StandardHandler } from "../standard/handler.js";
3
+ import { FriendlyStandardHandlerHandleOptions } from "../standard/utils.js";
4
+ import "../standard/index.js";
5
+ import { MaybeOptionalOptions, Promisable, Value } from "@orpc/shared";
6
+ import { DecodePeerMessageOptions, EncodePeerMessageOptions, ServerPeer } from "@standard-server/peer";
7
+ import { SupportedMessagePort } from "@orpc/client/message-port";
8
+ type DecodedResponseMessage = ConstructorParameters<typeof ServerPeer>[0] extends ((message: infer TMessage) => unknown) ? TMessage : never;
9
+ export interface MessagePortHandlerOptions<_T extends Context> {
10
+ /**
11
+ * By default, oRPC encodes peer messages as strings or binary data before sending them over the message port.
12
+ * Use this option to bypass encoding and leverage the full capabilities of the
13
+ * [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
14
+ * such as transferring object ownership or supporting non-serializable objects like `OffscreenCanvas` or improving performance.
15
+ *
16
+ * @remarks
17
+ * **Note**: Returning `null` or `undefined` disables this feature.
18
+ * **Warning**: Ensure your message port implementation supports `transferable` objects before enabling this.
19
+ */
20
+ experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedResponseMessage, port: SupportedMessagePort]> | undefined;
21
+ /**
22
+ * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
23
+ */
24
+ encodePeerMessage?: EncodePeerMessageOptions | undefined;
25
+ /**
26
+ * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
27
+ */
28
+ decodePeerMessage?: DecodePeerMessageOptions | undefined;
29
+ }
30
+ export declare class MessagePortHandler<T extends Context> {
31
+ private readonly handler;
32
+ /**
33
+ * `null` marks a closed port, so late messages never create a new peer.
34
+ */
35
+ private readonly peers;
36
+ private readonly transfer;
37
+ private readonly encodePeerMessageOptions;
38
+ private readonly decodePeerMessageOptions;
39
+ constructor(handler: StandardHandler<T>, options?: NoInfer<MessagePortHandlerOptions<T>>);
40
+ /**
41
+ * Attaches message and close listeners to a message port.
42
+ *
43
+ * Prefer this over calling `.message()` and `.close()` manually.
44
+ */
45
+ upgrade(port: SupportedMessagePort, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
46
+ /**
47
+ * Handles a single message received from a message port.
48
+ *
49
+ * @param port The message port instance. Use the same instance for all messages.
50
+ */
51
+ message(port: SupportedMessagePort, data: unknown, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
52
+ matched: boolean;
53
+ }>;
54
+ /**
55
+ * Cleans up peer state for a closed message port.
56
+ * Messages passed to `.message()` for this port afterwards are ignored.
57
+ *
58
+ * @param port The same message port instance passed to `.message()`.
59
+ */
60
+ close(port: SupportedMessagePort): Promise<void>;
61
+ }
62
+ export {};
@@ -0,0 +1,72 @@
1
+ import { createStandardPeerRequestHandler } from "../standard-peer/utils.js";
2
+ import { resolveMaybeOptionalOptions, value } from "@orpc/shared";
3
+ import { ServerPeer, decodePeerMessage, encodePeerMessage, isClientPeerSendMessage, isPeerMessage } from "@standard-server/peer";
4
+ import { onMessagePortClose, onMessagePortMessage, postMessagePortMessage } from "@orpc/client/message-port";
5
+ // src/adapters/message-port/handler.ts
6
+ var MessagePortHandler = class {
7
+ handler;
8
+ /**
9
+ * `null` marks a closed port, so late messages never create a new peer.
10
+ */
11
+ peers = /* @__PURE__ */ new WeakMap();
12
+ transfer;
13
+ encodePeerMessageOptions;
14
+ decodePeerMessageOptions;
15
+ constructor(handler, options = {}) {
16
+ this.handler = handler;
17
+ this.transfer = options.experimental_transfer;
18
+ this.encodePeerMessageOptions = options.encodePeerMessage;
19
+ this.decodePeerMessageOptions = options.decodePeerMessage;
20
+ }
21
+ /**
22
+ * Attaches message and close listeners to a message port.
23
+ *
24
+ * Prefer this over calling `.message()` and `.close()` manually.
25
+ */
26
+ upgrade(port, ...rest) {
27
+ /**
28
+ * Message order is important: loading -> decode -> .message.
29
+ * This flow must stay synchronous, or we need to use `sequential` helper
30
+ */
31
+ onMessagePortMessage(port, (message) => this.message(port, message, ...rest));
32
+ onMessagePortClose(port, () => this.close(port));
33
+ }
34
+ /**
35
+ * Handles a single message received from a message port.
36
+ *
37
+ * @param port The message port instance. Use the same instance for all messages.
38
+ */
39
+ async message(port, data, ...rest) {
40
+ let peerMessage;
41
+ if (typeof data === "string" || data instanceof Uint8Array) {
42
+ const result = decodePeerMessage(data, this.decodePeerMessageOptions);
43
+ if (result.matched && isClientPeerSendMessage(result.message)) peerMessage = result.message;
44
+ } else if (isPeerMessage(data) && isClientPeerSendMessage(data)) peerMessage = data;
45
+ if (peerMessage === void 0) return { matched: false };
46
+ let peer = this.peers.get(port);
47
+ if (peer === null) return { matched: true };
48
+ if (!peer) this.peers.set(port, peer = new ServerPeer(async (message) => {
49
+ const transfer = await value(this.transfer, message, port);
50
+ if (transfer) postMessagePortMessage(port, message, transfer);
51
+ else postMessagePortMessage(port, await encodePeerMessage(message, this.encodePeerMessageOptions));
52
+ }));
53
+ /**
54
+ * Message order is important: loading -> decode -> .message.
55
+ * This flow must stay synchronous, or we need to use `sequential` helper
56
+ */
57
+ await peer.message(peerMessage, createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest)));
58
+ return { matched: true };
59
+ }
60
+ /**
61
+ * Cleans up peer state for a closed message port.
62
+ * Messages passed to `.message()` for this port afterwards are ignored.
63
+ *
64
+ * @param port The same message port instance passed to `.message()`.
65
+ */
66
+ async close(port) {
67
+ const peer = this.peers.get(port);
68
+ this.peers.set(port, null);
69
+ await peer?.close();
70
+ }
71
+ };
72
+ export { MessagePortHandler };