@orpc/server 2.0.0-beta.47 → 2.0.0-beta.48

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 (169) hide show
  1. package/README.md +2 -3
  2. package/dist/adapters/aws-lambda/handler.d.mts +25 -0
  3. package/dist/adapters/aws-lambda/handler.mjs +21 -0
  4. package/dist/adapters/aws-lambda/index.d.mts +14 -49
  5. package/dist/adapters/aws-lambda/index.mjs +2 -39
  6. package/dist/adapters/aws-lambda/rpc-handler.d.mts +18 -0
  7. package/dist/adapters/aws-lambda/rpc-handler.mjs +10 -0
  8. package/dist/adapters/crossws/handler.d.mts +41 -0
  9. package/dist/adapters/crossws/handler.mjs +38 -0
  10. package/dist/adapters/crossws/index.d.mts +2 -63
  11. package/dist/adapters/crossws/index.mjs +2 -68
  12. package/dist/adapters/crossws/rpc-handler.d.mts +15 -0
  13. package/dist/adapters/crossws/rpc-handler.mjs +10 -0
  14. package/dist/adapters/fastify/handler.d.mts +21 -0
  15. package/dist/adapters/fastify/handler.mjs +20 -0
  16. package/dist/adapters/fastify/index.d.mts +2 -42
  17. package/dist/adapters/fastify/index.mjs +2 -39
  18. package/dist/adapters/fastify/rpc-handler.d.mts +14 -0
  19. package/dist/adapters/fastify/rpc-handler.mjs +10 -0
  20. package/dist/adapters/fetch/handler.d.mts +23 -0
  21. package/dist/adapters/fetch/handler.mjs +22 -0
  22. package/dist/adapters/fetch/index.d.mts +6 -46
  23. package/dist/adapters/fetch/index.mjs +4 -41
  24. package/dist/adapters/fetch/rpc-handler.d.mts +16 -0
  25. package/dist/adapters/fetch/rpc-handler.mjs +10 -0
  26. package/dist/adapters/message-port/handler.d.mts +57 -0
  27. package/dist/adapters/message-port/handler.mjs +62 -0
  28. package/dist/adapters/message-port/index.d.mts +2 -77
  29. package/dist/adapters/message-port/index.mjs +2 -87
  30. package/dist/adapters/message-port/rpc-handler.d.mts +15 -0
  31. package/dist/adapters/message-port/rpc-handler.mjs +10 -0
  32. package/dist/adapters/node/handler.d.mts +21 -0
  33. package/dist/adapters/node/handler.mjs +20 -0
  34. package/dist/adapters/node/index.d.mts +6 -43
  35. package/dist/adapters/node/index.mjs +4 -40
  36. package/dist/adapters/node/rpc-handler.d.mts +15 -0
  37. package/dist/adapters/node/rpc-handler.mjs +10 -0
  38. package/dist/adapters/standard/codec.d.mts +16 -0
  39. package/dist/adapters/standard/codec.mjs +1 -0
  40. package/dist/adapters/standard/handler.d.mts +68 -0
  41. package/dist/adapters/standard/handler.mjs +185 -0
  42. package/dist/adapters/standard/index.d.mts +6 -95
  43. package/dist/adapters/standard/index.mjs +5 -8
  44. package/dist/adapters/standard/plugin.d.mts +32 -0
  45. package/dist/adapters/standard/plugin.mjs +16 -0
  46. package/dist/adapters/standard/rpc-handler-codec.d.mts +42 -0
  47. package/dist/adapters/standard/rpc-handler-codec.mjs +51 -0
  48. package/dist/adapters/standard/rpc-matcher.d.mts +53 -0
  49. package/dist/adapters/standard/rpc-matcher.mjs +140 -0
  50. package/dist/adapters/standard/utils.d.mts +10 -0
  51. package/dist/adapters/standard/utils.mjs +6 -0
  52. package/dist/adapters/standard-peer/index.d.mts +1 -11
  53. package/dist/adapters/standard-peer/index.mjs +1 -10
  54. package/dist/adapters/standard-peer/utils.d.mts +4 -0
  55. package/dist/adapters/standard-peer/utils.mjs +11 -0
  56. package/dist/adapters/websocket/handler.d.mts +55 -0
  57. package/dist/adapters/websocket/handler.mjs +55 -0
  58. package/dist/adapters/websocket/index.d.mts +2 -77
  59. package/dist/adapters/websocket/index.mjs +2 -87
  60. package/dist/adapters/websocket/rpc-handler.d.mts +15 -0
  61. package/dist/adapters/websocket/rpc-handler.mjs +10 -0
  62. package/dist/builder-variants.d.mts +267 -0
  63. package/dist/builder-variants.mjs +1 -0
  64. package/dist/builder.d.mts +141 -0
  65. package/dist/builder.mjs +145 -0
  66. package/dist/constants.d.mts +2 -0
  67. package/dist/constants.mjs +2 -0
  68. package/dist/context.d.mts +13 -0
  69. package/dist/context.mjs +1 -0
  70. package/dist/extensions/callable.d.mts +16 -9
  71. package/dist/extensions/callable.mjs +5 -9
  72. package/dist/helpers/base64url.d.mts +31 -0
  73. package/dist/helpers/base64url.mjs +25 -0
  74. package/dist/helpers/cookie.d.mts +50 -0
  75. package/dist/helpers/cookie.mjs +35 -0
  76. package/dist/helpers/encryption.d.mts +28 -0
  77. package/dist/helpers/encryption.mjs +62 -0
  78. package/dist/helpers/index.d.mts +4 -167
  79. package/dist/helpers/index.mjs +4 -200
  80. package/dist/helpers/signing.d.mts +50 -0
  81. package/dist/helpers/signing.mjs +43 -0
  82. package/dist/implementer-procedure.d.mts +36 -0
  83. package/dist/implementer-procedure.mjs +38 -0
  84. package/dist/implementer-router.d.mts +78 -0
  85. package/dist/implementer-router.mjs +77 -0
  86. package/dist/implementer.d.mts +22 -0
  87. package/dist/implementer.mjs +30 -0
  88. package/dist/index.d.mts +57 -476
  89. package/dist/index.mjs +25 -458
  90. package/dist/lazy.d.mts +20 -0
  91. package/dist/lazy.mjs +22 -0
  92. package/dist/middleware-decorated.d.mts +27 -0
  93. package/dist/middleware-decorated.mjs +65 -0
  94. package/dist/middleware.d.mts +70 -0
  95. package/dist/middleware.mjs +1 -0
  96. package/dist/plugins/batch.d.mts +104 -0
  97. package/dist/plugins/batch.mjs +373 -0
  98. package/dist/plugins/cors.d.mts +67 -0
  99. package/dist/plugins/cors.mjs +134 -0
  100. package/dist/plugins/get-method-csrf-protection.d.mts +23 -0
  101. package/dist/plugins/get-method-csrf-protection.mjs +45 -0
  102. package/dist/plugins/head-method.d.mts +23 -0
  103. package/dist/plugins/head-method.mjs +95 -0
  104. package/dist/plugins/index.d.mts +39 -432
  105. package/dist/plugins/index.mjs +23 -965
  106. package/dist/plugins/method-override.d.mts +38 -0
  107. package/dist/plugins/method-override.mjs +50 -0
  108. package/dist/plugins/request-compression.d.mts +16 -0
  109. package/dist/plugins/request-compression.mjs +67 -0
  110. package/dist/plugins/request-headers.d.mts +22 -0
  111. package/dist/plugins/request-headers.mjs +21 -0
  112. package/dist/plugins/request-limit.d.mts +30 -0
  113. package/dist/plugins/request-limit.mjs +53 -0
  114. package/dist/plugins/response-compression.d.mts +59 -0
  115. package/dist/plugins/response-compression.mjs +172 -0
  116. package/dist/plugins/response-headers.d.mts +30 -0
  117. package/dist/plugins/response-headers.mjs +34 -0
  118. package/dist/plugins/rethrow.d.mts +33 -0
  119. package/dist/plugins/rethrow.mjs +46 -0
  120. package/dist/plugins/signal-sync.d.mts +13 -0
  121. package/dist/plugins/signal-sync.mjs +84 -0
  122. package/dist/plugins/timeout.d.mts +37 -0
  123. package/dist/plugins/timeout.mjs +56 -0
  124. package/dist/procedure-client.d.mts +41 -0
  125. package/dist/procedure-client.mjs +157 -0
  126. package/dist/procedure-decorated.d.mts +20 -0
  127. package/dist/procedure-decorated.mjs +41 -0
  128. package/dist/procedure-utils.d.mts +52 -0
  129. package/dist/procedure-utils.mjs +33 -0
  130. package/dist/procedure.d.mts +93 -0
  131. package/dist/procedure.mjs +20 -0
  132. package/dist/router-client.d.mts +27 -0
  133. package/dist/router-client.mjs +35 -0
  134. package/dist/router-hidden.d.mts +5 -0
  135. package/dist/router-hidden.mjs +12 -0
  136. package/dist/router-utils.d.mts +59 -0
  137. package/dist/router-utils.mjs +191 -0
  138. package/dist/router.d.mts +61 -0
  139. package/dist/router.mjs +1 -0
  140. package/package.json +11 -11
  141. package/dist/adapters/aws-lambda/index.d.ts +0 -51
  142. package/dist/adapters/crossws/index.d.ts +0 -63
  143. package/dist/adapters/fastify/index.d.ts +0 -42
  144. package/dist/adapters/fetch/index.d.ts +0 -47
  145. package/dist/adapters/message-port/index.d.ts +0 -77
  146. package/dist/adapters/node/index.d.ts +0 -44
  147. package/dist/adapters/standard/index.d.ts +0 -95
  148. package/dist/adapters/standard-peer/index.d.ts +0 -11
  149. package/dist/adapters/websocket/index.d.ts +0 -77
  150. package/dist/extensions/callable.d.ts +0 -10
  151. package/dist/helpers/index.d.ts +0 -167
  152. package/dist/index.d.ts +0 -476
  153. package/dist/plugins/index.d.ts +0 -432
  154. package/dist/shared/server.1ExWFMze.mjs +0 -69
  155. package/dist/shared/server.9B1jEm5a.d.mts +0 -105
  156. package/dist/shared/server.BB464y-6.mjs +0 -207
  157. package/dist/shared/server.BC5BIu02.d.mts +0 -73
  158. package/dist/shared/server.BSYGskId.d.ts +0 -14
  159. package/dist/shared/server.BvG3boBj.d.mts +0 -14
  160. package/dist/shared/server.CTV_mC2P.d.mts +0 -34
  161. package/dist/shared/server.CYbIpHbH.mjs +0 -239
  162. package/dist/shared/server.CgBF3Vj1.d.ts +0 -34
  163. package/dist/shared/server.Chq5FpXf.mjs +0 -353
  164. package/dist/shared/server.DFPxP2v3.d.mts +0 -166
  165. package/dist/shared/server.DFPxP2v3.d.ts +0 -166
  166. package/dist/shared/server.DOg7ke6y.d.ts +0 -105
  167. package/dist/shared/server.Dz7j9BEh.d.ts +0 -73
  168. package/dist/shared/server.W91HSRkE.mjs +0 -9
  169. package/dist/shared/server.sBQSgqK3.mjs +0 -41
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,68 @@
1
+ import type { ErrorMap, Schema } from "@orpc/contract";
2
+ import type { Interceptor, Promisable, Value } from "@orpc/shared";
3
+ import type { StandardLazyRequest, StandardResponse } from "@standard-server/core";
4
+ import type { Context } from "../../context.mjs";
5
+ import type { ProcedureClientInterceptor } from "../../procedure-client.mjs";
6
+ import type { StandardHandlerCodec, StandardHandlerCodecResolvedProcedure } from "./codec.mjs";
7
+ import type { StandardHandlerPlugin } from "./plugin.mjs";
8
+ export interface StandardHandlerHandleOptions<T extends Context> {
9
+ prefix?: `/${string}` | undefined;
10
+ /**
11
+ * The initial context, or a function (sync or async) that receives the request and returns it.
12
+ * The function only runs once the request passes the prefix check.
13
+ */
14
+ context: Value<Promisable<T>, [request: StandardLazyRequest]>;
15
+ }
16
+ /**
17
+ * `StandardHandlerHandleOptions` after the context has been resolved,
18
+ * this is what interceptors and codecs receive.
19
+ */
20
+ export interface ResolvedStandardHandlerHandleOptions<T extends Context> extends Omit<StandardHandlerHandleOptions<T>, "context"> {
21
+ context: T;
22
+ }
23
+ export type StandardHandlerHandleResult = {
24
+ matched: true;
25
+ response: StandardResponse;
26
+ } | {
27
+ matched: false;
28
+ response?: undefined;
29
+ };
30
+ export interface StandardHandlerInterceptorOptions<T extends Context> extends StandardHandlerCodecResolvedProcedure, ResolvedStandardHandlerHandleOptions<T> {
31
+ request: StandardLazyRequest;
32
+ }
33
+ export type StandardHandlerInterceptor<T extends Context> = Interceptor<StandardHandlerInterceptorOptions<T>, Promise<StandardResponse>>;
34
+ export interface StandardHandlerRoutingInterceptorOptions<T extends Context> extends ResolvedStandardHandlerHandleOptions<T> {
35
+ request: StandardLazyRequest;
36
+ }
37
+ export type StandardHandlerRoutingInterceptor<T extends Context> = Interceptor<StandardHandlerRoutingInterceptorOptions<T>, Promise<StandardHandlerHandleResult>>;
38
+ export interface StandardHandlerOptions<TContext extends Context> {
39
+ /**
40
+ * Fired on every request before routing, useful when you want
41
+ * to intercept all requests regardless of whether they match a procedure or not.
42
+ *
43
+ * @examples
44
+ * - batch plugins - separate one request into multiple and call multiple next
45
+ * - openapi spec plugin - to intercept a request and early response
46
+ */
47
+ routingInterceptors?: StandardHandlerRoutingInterceptor<TContext>[] | undefined;
48
+ /**
49
+ * interceptor run after routing and before error handler,
50
+ * useful for error handling, logging, metrics, etc.
51
+ */
52
+ interceptors?: StandardHandlerInterceptor<TContext>[] | undefined;
53
+ /**
54
+ *
55
+ * ClientInterceptor equivalent with createRouterClient.interceptors / createProcedure.interceptors
56
+ * useful for error handling, logging, metrics, etc. (not counting encoding/decoding)
57
+ */
58
+ clientInterceptors?: ProcedureClientInterceptor<TContext, Schema<unknown>, ErrorMap>[] | undefined;
59
+ plugins?: StandardHandlerPlugin<TContext>[] | undefined;
60
+ }
61
+ export declare class StandardHandler<T extends Context> {
62
+ private readonly codec;
63
+ private readonly routingInterceptors;
64
+ private readonly interceptors;
65
+ private readonly clientInterceptors;
66
+ constructor(codec: StandardHandlerCodec<T>, options: StandardHandlerOptions<T>);
67
+ handle(request: StandardLazyRequest, options: StandardHandlerHandleOptions<T>): Promise<StandardHandlerHandleResult>;
68
+ }
@@ -0,0 +1,185 @@
1
+ import { ORPCError, toORPCError } from "@orpc/client";
2
+ import { getTracer, intercept, isAsyncIteratorObject, matchesHttpPathPrefix, ORPC_NAME, override, recordSpanError, runWithSpan, toArray, toTracingException, traceAsyncIterator, traceReadableStream, value, wrapAsyncIterator, wrapReadableStream } from "@orpc/shared";
3
+ import { ErrorEvent, flattenStandardHeader, parseStandardUrl } from "@standard-server/core";
4
+ import { createProcedureClient } from "../../procedure-client.mjs";
5
+ import { CompositeStandardHandlerPlugin } from "./plugin.mjs";
6
+ export class StandardHandler {
7
+ codec;
8
+ routingInterceptors;
9
+ interceptors;
10
+ clientInterceptors;
11
+ constructor(codec, options) {
12
+ this.codec = codec;
13
+ options = new CompositeStandardHandlerPlugin([...toArray(options.plugins), new TracingHandlerPlugin()]).init(options);
14
+ this.routingInterceptors = options.routingInterceptors;
15
+ this.interceptors = options.interceptors;
16
+ this.clientInterceptors = options.clientInterceptors;
17
+ }
18
+ async handle(request, options) {
19
+ const { prefix } = options;
20
+ if (prefix && !matchesHttpPathPrefix(request.url, prefix)) {
21
+ return {
22
+ matched: false,
23
+ response: undefined
24
+ };
25
+ }
26
+ const context = await value(options.context, request);
27
+ return intercept(this.routingInterceptors, {
28
+ context,
29
+ prefix,
30
+ request
31
+ }, async ({ context, prefix, request }) => {
32
+ const span = getTracer()?.getActiveSpan();
33
+ let step;
34
+ const matchedOrNot = await runWithSpan("find_procedure", () => this.codec.resolveProcedure(request, {
35
+ context,
36
+ prefix
37
+ }));
38
+ if (!matchedOrNot) {
39
+
40
+ span?.updateName(`${ORPC_NAME}_no_match`);
41
+ span?.setAttribute("http.request.method", request.method);
42
+ span?.setAttribute("url.path", request.url);
43
+ return { matched: false };
44
+ }
45
+ const { path, procedure, decodeInput } = matchedOrNot;
46
+
47
+ span?.updateName(`${ORPC_NAME}.${path.join("/")}`);
48
+ span?.setAttribute("rpc.system", ORPC_NAME);
49
+ span?.setAttribute("rpc.method", path.join("."));
50
+ try {
51
+ const response = await intercept(this.interceptors, {
52
+ context,
53
+ prefix,
54
+ request,
55
+ path,
56
+ procedure,
57
+ decodeInput
58
+ }, async ({ context, prefix, request, path, procedure, decodeInput }) => {
59
+ step = "decode_input";
60
+ let input = await runWithSpan("decode_input", decodeInput);
61
+ step = undefined;
62
+ if (getTracer() && isAsyncIteratorObject(input)) {
63
+
64
+ input = override(input, traceAsyncIterator("consume_async_iterator_object_input", input));
65
+ } else if (getTracer() && input instanceof ReadableStream) {
66
+
67
+ input = override(input, traceReadableStream("consume_octet_stream_input", input));
68
+ }
69
+ const client = createProcedureClient(procedure, {
70
+ context,
71
+ path,
72
+ interceptors: this.clientInterceptors
73
+ });
74
+
75
+ step = "call_procedure";
76
+ const output = await client(input, {
77
+ signal: request.signal,
78
+ lastEventId: flattenStandardHeader(request.headers["last-event-id"])
79
+ });
80
+ step = undefined;
81
+ const response = await this.codec.encodeOutput(output, procedure, path, {
82
+ context,
83
+ prefix
84
+ });
85
+ return response;
86
+ });
87
+ return {
88
+ matched: true,
89
+ response
90
+ };
91
+ } catch (e) {
92
+
93
+ if (step !== "call_procedure") {
94
+ recordSpanError(span, e);
95
+ }
96
+ const error = step === "decode_input" && !(e instanceof ORPCError) ? new ORPCError("BAD_REQUEST", {
97
+ message: `Malformed request. Ensure the request body is properly formatted and the 'Content-Type' header is set correctly.`,
98
+ cause: e
99
+ }) : toORPCError(e);
100
+ const response = await this.codec.encodeError(error, procedure, path, {
101
+ context,
102
+ prefix
103
+ });
104
+ return {
105
+ matched: true,
106
+ response
107
+ };
108
+ }
109
+ });
110
+ }
111
+ }
112
+ class TracingHandlerPlugin {
113
+ name = "~tracing";
114
+ init(options) {
115
+ return {
116
+ ...options,
117
+ routingInterceptors: [async ({ next, request }) => {
118
+ const tracer = getTracer();
119
+ if (!tracer) {
120
+ return next();
121
+ }
122
+ const parent = tracer.extract?.(request.headers);
123
+
124
+ const [pathname] = parseStandardUrl(request.url);
125
+ return tracer.startActiveSpan(`${request.method} ${pathname}`, parent, async (span) => {
126
+ try {
127
+ const result = await next();
128
+ if (!result.matched) {
129
+ span.end();
130
+ return result;
131
+ }
132
+ const body = result.response.body;
133
+ if (isAsyncIteratorObject(body)) {
134
+ return {
135
+ ...result,
136
+ response: {
137
+ ...result.response,
138
+
139
+ body: override(body, wrapAsyncIterator(body, {
140
+ runWith: (fn) => tracer.withActiveSpan(span, fn),
141
+ onError(error) {
142
+
143
+ if (!(error instanceof ErrorEvent)) {
144
+ span.recordException("error", toTracingException(error));
145
+ }
146
+ },
147
+ onFinish() {
148
+ span.end();
149
+ }
150
+ }))
151
+ }
152
+ };
153
+ }
154
+ if (body instanceof ReadableStream) {
155
+ return {
156
+ ...result,
157
+ response: {
158
+ ...result.response,
159
+
160
+ body: override(body, wrapReadableStream(body, {
161
+ runWith: (fn) => tracer.withActiveSpan(span, fn),
162
+ onError(error) {
163
+
164
+ span.recordException("error", toTracingException(error));
165
+ },
166
+ onFinish() {
167
+ span.end();
168
+ }
169
+ }))
170
+ }
171
+ };
172
+ }
173
+ span.end();
174
+ return result;
175
+ } catch (e) {
176
+
177
+ span.recordException("error", toTracingException(e));
178
+ span.end();
179
+ throw e;
180
+ }
181
+ });
182
+ }, ...toArray(options.routingInterceptors)]
183
+ };
184
+ }
185
+ }
@@ -1,95 +1,6 @@
1
- import { R as ResolvedStandardHandlerHandleOptions, f as StandardHandlerCodec, g as StandardHandlerCodecResolvedProcedure } from '../../shared/server.9B1jEm5a.mjs';
2
- export { S as StandardHandler, a as StandardHandlerHandleOptions, h as StandardHandlerHandleResult, i as StandardHandlerInterceptor, e as StandardHandlerInterceptorOptions, c as StandardHandlerOptions, b as StandardHandlerPlugin, j as StandardHandlerRoutingInterceptor, d as StandardHandlerRoutingInterceptorOptions } from '../../shared/server.9B1jEm5a.mjs';
3
- import { RPCSerializer, AnyORPCError } from '@orpc/client';
4
- import { Value, Public, Promisable } from '@orpc/shared';
5
- import { StandardMethod, StandardLazyRequest, StandardResponse } from '@standard-server/core';
6
- import { AnyProcedure, Context } from '../../index.mjs';
7
- import { AnyRouter } from '../../index.mjs';
8
- import { AnyProcedureContract } from '@orpc/contract';
9
- export { F as FriendlyStandardHandlerHandleOptions, r as resolveFriendlyStandardHandlerHandleOptions } from '../../shared/server.BvG3boBj.mjs';
10
-
11
- /**
12
- * Methods that can invoke procedures by default. Browsers cannot trigger them
13
- * cross-site without a CORS preflight or an HTML form, unlike `GET`, which a plain
14
- * `<a>` click or redirect can trigger with `SameSite=Lax` cookies attached. Other
15
- * methods (`HEAD`, `OPTIONS`, `QUERY`, ...) have safe semantics that should not
16
- * invoke a procedure that can modify data.
17
- *
18
- * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
19
- */
20
- declare const RPC_DEFAULT_ALLOW_METHODS: readonly StandardMethod[];
21
- interface RPCMatcherOptions {
22
- /**
23
- * Filter which procedures are exposed for matching. Return `false` to exclude.
24
- *
25
- * @default true
26
- */
27
- filter?: Value<boolean, [procedure: AnyProcedureContract | AnyProcedure, path: string[]]> | undefined;
28
- /**
29
- * Restricts which HTTP methods can invoke procedures, either with a list of allowed
30
- * methods or decided per request via a function. Requests using a disallowed method
31
- * are treated as unmatched. `GET` is excluded by default because it is exposed to
32
- * Cross-Site Request Forgery (CSRF) attacks.
33
- *
34
- * @default RPC_DEFAULT_ALLOW_METHODS (['POST', 'PUT', 'PATCH', 'DELETE'])
35
- * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
36
- */
37
- allowMethods?: readonly StandardMethod[] | ((method: StandardMethod, procedure: AnyProcedure, path: string[]) => boolean) | undefined;
38
- }
39
- declare class RPCMatcher {
40
- private readonly filter;
41
- private readonly allowMethodsSet;
42
- private readonly allowMethodsFn;
43
- private readonly rootRouter;
44
- private readonly tree;
45
- private readonly pendingLazyRouters;
46
- /** segment count of the deepest pending key, never lowered so it stays an upper bound */
47
- private maxPendingLazyRouterDepth;
48
- constructor(router: AnyRouter, options?: RPCMatcherOptions);
49
- private index;
50
- match(method: StandardMethod, pathname: `/${string}`, prefix: `/${string}` | undefined): Promise<{
51
- path: string[];
52
- procedure: AnyProcedure;
53
- } | undefined>;
54
- private resolvePendingLazyRouters;
55
- private loadPendingLazyRouter;
56
- private indexPendingLazyRouter;
57
- private resolveProcedure;
58
- }
59
-
60
- interface RPCHandlerCodecOptions<T extends Context> extends RPCMatcherOptions {
61
- /**
62
- * Override the default RPC serializer.
63
- */
64
- serializer?: Public<RPCSerializer> | undefined;
65
- /**
66
- * Resolve HTTP status for encoded successful outputs.
67
- *
68
- * Value should be in the `2xx` range and must be less than `400`.
69
- * Return `undefined` or `null` to fallback to default
70
- *
71
- * @default DEFAULT_SUCCESS_STATUS (200)
72
- */
73
- outputStatus?: Value<number | undefined | null, [output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>]> | undefined;
74
- /**
75
- * Mapping ORPCError Code -> HTTP Status Code
76
- * The status code should be in the `4xx` or `5xx` range (must be greater than or equal to `400`).
77
- * Codes missing from the map fall back to `DEFAULT_ERROR_STATUS` (400).
78
- *
79
- * @default COMMON_ERROR_STATUS_MAP
80
- */
81
- errorStatusMap?: Record<string, number> | undefined;
82
- }
83
- declare class RPCHandlerCodec<T extends Context> implements StandardHandlerCodec<T> {
84
- private readonly matcher;
85
- private readonly serializer;
86
- private readonly errorStatusMap;
87
- private readonly outputStatus;
88
- constructor(router: AnyRouter, options?: RPCHandlerCodecOptions<T>);
89
- resolveProcedure(request: StandardLazyRequest, options: ResolvedStandardHandlerHandleOptions<T>): Promise<StandardHandlerCodecResolvedProcedure | undefined>;
90
- encodeOutput(output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
91
- encodeError(error: AnyORPCError, _procedure: AnyProcedure, _path: string[], _options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
92
- }
93
-
94
- export { RPCHandlerCodec, RPCMatcher, RPC_DEFAULT_ALLOW_METHODS, ResolvedStandardHandlerHandleOptions, StandardHandlerCodec, StandardHandlerCodecResolvedProcedure };
95
- export type { RPCHandlerCodecOptions, RPCMatcherOptions };
1
+ export * from "./codec.mjs";
2
+ export * from "./handler.mjs";
3
+ export type { StandardHandlerPlugin } from "./plugin.mjs";
4
+ export * from "./rpc-handler-codec.mjs";
5
+ export * from "./rpc-matcher.mjs";
6
+ export * from "./utils.mjs";
@@ -1,8 +1,5 @@
1
- export { R as RPCHandlerCodec, a as RPCMatcher, b as RPC_DEFAULT_ALLOW_METHODS, S as StandardHandler } from '../../shared/server.Chq5FpXf.mjs';
2
- export { r as resolveFriendlyStandardHandlerHandleOptions } from '../../shared/server.W91HSRkE.mjs';
3
- import '@orpc/client';
4
- import '@orpc/shared';
5
- import '@standard-server/core';
6
- import '../../shared/server.BB464y-6.mjs';
7
- import '@orpc/contract';
8
- import '../../shared/server.CYbIpHbH.mjs';
1
+ export * from "./codec.mjs";
2
+ export * from "./handler.mjs";
3
+ export * from "./rpc-handler-codec.mjs";
4
+ export * from "./rpc-matcher.mjs";
5
+ export * from "./utils.mjs";
@@ -0,0 +1,32 @@
1
+ import type { OrderablePlugin } from "@orpc/shared";
2
+ import type { Context } from "../../context.mjs";
3
+ import type { StandardHandlerOptions } from "./handler.mjs";
4
+ export interface StandardHandlerPlugin<T extends Context> extends OrderablePlugin {
5
+ /**
6
+ * Initializes the plugin and returns new handler options.
7
+ * Called once per plugin instance during composition.
8
+ *
9
+ * This method allows plugins to wrap, extend, or transform handler options
10
+ * such as interceptors, or configuration.
11
+ *
12
+ * @param options - The current handler options from previous plugins or base configuration
13
+ * @returns Transformed handler options with plugin's modifications applied
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * init(options) {
18
+ * return {
19
+ * ...options,
20
+ * interceptors: [...(options.interceptors || []), myInterceptor]
21
+ * }
22
+ * }
23
+ * ```
24
+ */
25
+ init?(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
26
+ }
27
+ export declare class CompositeStandardHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
28
+ readonly name = "~composite";
29
+ protected readonly plugins: StandardHandlerPlugin<T>[];
30
+ constructor(plugins?: StandardHandlerPlugin<T>[]);
31
+ init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
32
+ }
@@ -0,0 +1,16 @@
1
+ import { sortPlugins } from "@orpc/shared";
2
+ export class CompositeStandardHandlerPlugin {
3
+ name = "~composite";
4
+ plugins;
5
+ constructor(plugins = []) {
6
+ this.plugins = sortPlugins(plugins);
7
+ }
8
+ init(options) {
9
+ for (const plugin of this.plugins) {
10
+ if (plugin.init) {
11
+ options = plugin.init(options);
12
+ }
13
+ }
14
+ return options;
15
+ }
16
+ }
@@ -0,0 +1,42 @@
1
+ import type { AnyORPCError } from "@orpc/client";
2
+ import type { Promisable, Public, Value } from "@orpc/shared";
3
+ import type { StandardLazyRequest, StandardResponse } from "@standard-server/core";
4
+ import type { Context } from "../../context.mjs";
5
+ import type { AnyProcedure } from "../../procedure.mjs";
6
+ import type { AnyRouter } from "../../router.mjs";
7
+ import type { ResolvedStandardHandlerHandleOptions, StandardHandlerCodec, StandardHandlerCodecResolvedProcedure } from "./index.mjs";
8
+ import type { RPCMatcherOptions } from "./rpc-matcher.mjs";
9
+ import { RPCSerializer } from "@orpc/client";
10
+ export interface RPCHandlerCodecOptions<T extends Context> extends RPCMatcherOptions {
11
+ /**
12
+ * Override the default RPC serializer.
13
+ */
14
+ serializer?: Public<RPCSerializer> | undefined;
15
+ /**
16
+ * Resolve HTTP status for encoded successful outputs.
17
+ *
18
+ * Value should be in the `2xx` range and must be less than `400`.
19
+ * Return `undefined` or `null` to fallback to default
20
+ *
21
+ * @default DEFAULT_SUCCESS_STATUS (200)
22
+ */
23
+ outputStatus?: Value<number | undefined | null, [output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>]> | undefined;
24
+ /**
25
+ * Mapping ORPCError Code -> HTTP Status Code
26
+ * The status code should be in the `4xx` or `5xx` range (must be greater than or equal to `400`).
27
+ * Codes missing from the map fall back to `DEFAULT_ERROR_STATUS` (400).
28
+ *
29
+ * @default COMMON_ERROR_STATUS_MAP
30
+ */
31
+ errorStatusMap?: Record<string, number> | undefined;
32
+ }
33
+ export declare class RPCHandlerCodec<T extends Context> implements StandardHandlerCodec<T> {
34
+ private readonly matcher;
35
+ private readonly serializer;
36
+ private readonly errorStatusMap;
37
+ private readonly outputStatus;
38
+ constructor(router: AnyRouter, options?: RPCHandlerCodecOptions<T>);
39
+ resolveProcedure(request: StandardLazyRequest, options: ResolvedStandardHandlerHandleOptions<T>): Promise<StandardHandlerCodecResolvedProcedure | undefined>;
40
+ encodeOutput(output: unknown, procedure: AnyProcedure, path: string[], options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
41
+ encodeError(error: AnyORPCError, _procedure: AnyProcedure, _path: string[], _options: ResolvedStandardHandlerHandleOptions<T>): Promisable<StandardResponse>;
42
+ }
@@ -0,0 +1,51 @@
1
+ import { COMMON_ERROR_STATUS_MAP, RPCSerializer } from "@orpc/client";
2
+ import { getOwn, parseEmptyableJSON, value } from "@orpc/shared";
3
+ import { parseStandardUrl } from "@standard-server/core";
4
+ import { DEFAULT_ERROR_STATUS, DEFAULT_SUCCESS_STATUS } from "../../constants.mjs";
5
+ import { RPCMatcher } from "./rpc-matcher.mjs";
6
+ export class RPCHandlerCodec {
7
+ matcher;
8
+ serializer;
9
+ errorStatusMap;
10
+ outputStatus;
11
+ constructor(router, options = {}) {
12
+ this.matcher = new RPCMatcher(router, options);
13
+ this.serializer = options.serializer ?? new RPCSerializer();
14
+ this.errorStatusMap = options.errorStatusMap ?? COMMON_ERROR_STATUS_MAP;
15
+ this.outputStatus = options.outputStatus;
16
+ }
17
+ async resolveProcedure(request, options) {
18
+ const [pathname, query] = parseStandardUrl(request.url);
19
+ const matched = await this.matcher.match(request.method, pathname, options.prefix);
20
+ if (!matched) {
21
+ return undefined;
22
+ }
23
+ return {
24
+ procedure: matched.procedure,
25
+ path: matched.path,
26
+ decodeInput: async () => {
27
+ if (request.method === "GET") {
28
+ const dataString = new URLSearchParams(query).getAll("data").at(-1);
29
+ return this.serializer.deserialize(parseEmptyableJSON(dataString));
30
+ }
31
+ const body = await request.resolveBody();
32
+ return this.serializer.deserialize(body);
33
+ }
34
+ };
35
+ }
36
+ encodeOutput(output, procedure, path, options) {
37
+ return {
38
+ headers: {},
39
+ status: value(this.outputStatus, output, procedure, path, options) ?? DEFAULT_SUCCESS_STATUS,
40
+ body: this.serializer.serialize(output)
41
+ };
42
+ }
43
+ encodeError(error, _procedure, _path, _options) {
44
+ const status = getOwn(this.errorStatusMap, error.code) ?? DEFAULT_ERROR_STATUS;
45
+ return {
46
+ headers: {},
47
+ status,
48
+ body: this.serializer.serialize(error.toJSON())
49
+ };
50
+ }
51
+ }
@@ -0,0 +1,53 @@
1
+ import type { AnyProcedureContract } from "@orpc/contract";
2
+ import type { Value } from "@orpc/shared";
3
+ import type { StandardMethod } from "@standard-server/core";
4
+ import type { AnyProcedure } from "../../procedure.mjs";
5
+ import type { AnyRouter } from "../../router.mjs";
6
+ /**
7
+ * Methods that can invoke procedures by default. Browsers cannot trigger them
8
+ * cross-site without a CORS preflight or an HTML form, unlike `GET`, which a plain
9
+ * `<a>` click or redirect can trigger with `SameSite=Lax` cookies attached. Other
10
+ * methods (`HEAD`, `OPTIONS`, `QUERY`, ...) have safe semantics that should not
11
+ * invoke a procedure that can modify data.
12
+ *
13
+ * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
14
+ */
15
+ export declare const RPC_DEFAULT_ALLOW_METHODS: readonly StandardMethod[];
16
+ export interface RPCMatcherOptions {
17
+ /**
18
+ * Filter which procedures are exposed for matching. Return `false` to exclude.
19
+ *
20
+ * @default true
21
+ */
22
+ filter?: Value<boolean, [procedure: AnyProcedureContract | AnyProcedure, path: string[]]> | undefined;
23
+ /**
24
+ * Restricts which HTTP methods can invoke procedures, either with a list of allowed
25
+ * methods or decided per request via a function. Requests using a disallowed method
26
+ * are treated as unmatched. `GET` is excluded by default because it is exposed to
27
+ * Cross-Site Request Forgery (CSRF) attacks.
28
+ *
29
+ * @default RPC_DEFAULT_ALLOW_METHODS (['POST', 'PUT', 'PATCH', 'DELETE'])
30
+ * @see {@link https://orpc.dev/docs/rpc/handler#supported-http-methods | RPC Handler - Supported HTTP Methods}
31
+ */
32
+ allowMethods?: readonly StandardMethod[] | ((method: StandardMethod, procedure: AnyProcedure, path: string[]) => boolean) | undefined;
33
+ }
34
+ export declare class RPCMatcher {
35
+ private readonly filter;
36
+ private readonly allowMethodsSet;
37
+ private readonly allowMethodsFn;
38
+ private readonly rootRouter;
39
+ private readonly tree;
40
+ private readonly pendingLazyRouters;
41
+ /** segment count of the deepest pending key, never lowered so it stays an upper bound */
42
+ private maxPendingLazyRouterDepth;
43
+ constructor(router: AnyRouter, options?: RPCMatcherOptions);
44
+ private index;
45
+ match(method: StandardMethod, pathname: `/${string}`, prefix: `/${string}` | undefined): Promise<{
46
+ path: string[];
47
+ procedure: AnyProcedure;
48
+ } | undefined>;
49
+ private resolvePendingLazyRouters;
50
+ private loadPendingLazyRouter;
51
+ private indexPendingLazyRouter;
52
+ private resolveProcedure;
53
+ }