@orpc/server 0.0.0-next.68378b4 → 0.0.0-next.683f2ee

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 (75) hide show
  1. package/README.md +149 -29
  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 +40 -0
  5. package/dist/adapters/bun-ws/index.d.mts +36 -0
  6. package/dist/adapters/bun-ws/index.d.ts +36 -0
  7. package/dist/adapters/bun-ws/index.mjs +47 -0
  8. package/dist/adapters/crossws/index.d.mts +33 -0
  9. package/dist/adapters/crossws/index.d.ts +33 -0
  10. package/dist/adapters/crossws/index.mjs +45 -0
  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 +52 -0
  14. package/dist/adapters/fetch/index.d.mts +108 -10
  15. package/dist/adapters/fetch/index.d.ts +108 -10
  16. package/dist/adapters/fetch/index.mjs +177 -7
  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 +86 -21
  21. package/dist/adapters/node/index.d.ts +86 -21
  22. package/dist/adapters/node/index.mjs +142 -23
  23. package/dist/adapters/standard/index.d.mts +11 -15
  24. package/dist/adapters/standard/index.d.ts +11 -15
  25. package/dist/adapters/standard/index.mjs +5 -3
  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 +21 -0
  29. package/dist/adapters/websocket/index.d.mts +56 -0
  30. package/dist/adapters/websocket/index.d.ts +56 -0
  31. package/dist/adapters/websocket/index.mjs +67 -0
  32. package/dist/adapters/ws/index.d.mts +31 -0
  33. package/dist/adapters/ws/index.d.ts +31 -0
  34. package/dist/adapters/ws/index.mjs +37 -0
  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 +680 -132
  42. package/dist/index.d.ts +680 -132
  43. package/dist/index.mjs +213 -54
  44. package/dist/plugins/index.d.mts +193 -20
  45. package/dist/plugins/index.d.ts +193 -20
  46. package/dist/plugins/index.mjs +241 -16
  47. package/dist/shared/server.7cEtMB30.d.ts +74 -0
  48. package/dist/shared/server.B8gYOD5g.d.mts +12 -0
  49. package/dist/shared/server.BOmqcs4W.mjs +421 -0
  50. package/dist/shared/server.BqadksTP.d.mts +74 -0
  51. package/dist/shared/server.C8_sRzQB.d.mts +42 -0
  52. package/dist/shared/server.ChUyt5-i.d.mts +32 -0
  53. package/dist/shared/server.ChyoA9XY.d.ts +42 -0
  54. package/dist/shared/server.DZ5BIITo.mjs +9 -0
  55. package/dist/shared/server.Dz5G6M6M.mjs +226 -0
  56. package/dist/shared/server.EfTOZ2Q7.d.ts +12 -0
  57. package/dist/shared/server.TEVCLCFC.mjs +39 -0
  58. package/dist/shared/server.qKsRrdxW.d.mts +193 -0
  59. package/dist/shared/server.qKsRrdxW.d.ts +193 -0
  60. package/dist/shared/server.yoEB3Fx4.d.ts +32 -0
  61. package/package.json +83 -23
  62. package/dist/adapters/hono/index.d.mts +0 -19
  63. package/dist/adapters/hono/index.d.ts +0 -19
  64. package/dist/adapters/hono/index.mjs +0 -32
  65. package/dist/adapters/next/index.d.mts +0 -26
  66. package/dist/adapters/next/index.d.ts +0 -26
  67. package/dist/adapters/next/index.mjs +0 -29
  68. package/dist/shared/server.BHIDiY4a.mjs +0 -28
  69. package/dist/shared/server.CtBp-i4f.d.mts +0 -77
  70. package/dist/shared/server.DKrKGnk2.mjs +0 -161
  71. package/dist/shared/server.Drm1Lma3.d.ts +0 -77
  72. package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
  73. package/dist/shared/server.V6zT5iYQ.mjs +0 -379
  74. package/dist/shared/server.ptXwNGQr.d.mts +0 -158
  75. package/dist/shared/server.ptXwNGQr.d.ts +0 -158
@@ -1,9 +1,125 @@
1
- export { C as CompositePlugin } from '../shared/server.Q6ZmnTgO.mjs';
2
- import { value } from '@orpc/shared';
1
+ import { runWithSpan, value, setSpanError, isAsyncIteratorObject, AsyncIteratorClass, clone } from '@orpc/shared';
2
+ import { flattenHeader } from '@orpc/standard-server';
3
+ import { parseBatchRequest, toBatchResponse } from '@orpc/standard-server/batch';
4
+ import { toFetchHeaders } from '@orpc/standard-server-fetch';
5
+ import { ORPCError } from '@orpc/client';
6
+ export { S as StrictGetMethodPlugin } from '../shared/server.TEVCLCFC.mjs';
7
+ import '@orpc/contract';
8
+
9
+ class BatchHandlerPlugin {
10
+ maxSize;
11
+ mapRequestItem;
12
+ successStatus;
13
+ headers;
14
+ order = 5e6;
15
+ constructor(options = {}) {
16
+ this.maxSize = options.maxSize ?? 10;
17
+ this.mapRequestItem = options.mapRequestItem ?? ((request, { request: batchRequest }) => ({
18
+ ...request,
19
+ headers: {
20
+ ...batchRequest.headers,
21
+ ...request.headers
22
+ }
23
+ }));
24
+ this.successStatus = options.successStatus ?? 207;
25
+ this.headers = options.headers ?? {};
26
+ }
27
+ init(options) {
28
+ options.rootInterceptors ??= [];
29
+ options.rootInterceptors.unshift(async (options2) => {
30
+ const xHeader = flattenHeader(options2.request.headers["x-orpc-batch"]);
31
+ if (xHeader === void 0) {
32
+ return options2.next();
33
+ }
34
+ let isParsing = false;
35
+ try {
36
+ return await runWithSpan({ name: "handle_batch_request" }, async (span) => {
37
+ const mode = xHeader === "buffered" ? "buffered" : "streaming";
38
+ isParsing = true;
39
+ const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
40
+ isParsing = false;
41
+ span?.setAttribute("batch.mode", mode);
42
+ span?.setAttribute("batch.size", parsed.length);
43
+ const maxSize = await value(this.maxSize, options2);
44
+ if (parsed.length > maxSize) {
45
+ const message = "Batch request size exceeds the maximum allowed size";
46
+ setSpanError(span, message);
47
+ return {
48
+ matched: true,
49
+ response: {
50
+ status: 413,
51
+ headers: {},
52
+ body: message
53
+ }
54
+ };
55
+ }
56
+ const responses = parsed.map(
57
+ (request, index) => {
58
+ const mapped = this.mapRequestItem(request, options2);
59
+ return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
60
+ span?.addEvent(`response.${index}.${matched ? "success" : "not_matched"}`);
61
+ if (matched) {
62
+ if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
63
+ return {
64
+ index,
65
+ status: 500,
66
+ headers: {},
67
+ body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
68
+ };
69
+ }
70
+ return { ...response2, index };
71
+ }
72
+ return { index, status: 404, headers: {}, body: "No procedure matched" };
73
+ }).catch((err) => {
74
+ Promise.reject(err);
75
+ return { index, status: 500, headers: {}, body: "Internal server error" };
76
+ });
77
+ }
78
+ );
79
+ await Promise.race(responses);
80
+ const status = await value(this.successStatus, responses, options2);
81
+ const headers = await value(this.headers, responses, options2);
82
+ const promises = [...responses];
83
+ const response = await toBatchResponse({
84
+ status,
85
+ headers,
86
+ mode,
87
+ body: new AsyncIteratorClass(
88
+ async () => {
89
+ const handling = promises.filter((p) => p !== void 0);
90
+ if (handling.length <= 0) {
91
+ return { done: true, value: void 0 };
92
+ }
93
+ const value2 = await Promise.race(handling);
94
+ promises[value2.index] = void 0;
95
+ return { done: false, value: value2 };
96
+ },
97
+ async () => {
98
+ }
99
+ )
100
+ });
101
+ return {
102
+ matched: true,
103
+ response
104
+ };
105
+ });
106
+ } catch (cause) {
107
+ if (isParsing) {
108
+ return {
109
+ matched: true,
110
+ response: { status: 400, headers: {}, body: "Invalid batch request, this could be caused by a malformed request body or a missing header" }
111
+ };
112
+ }
113
+ throw cause;
114
+ }
115
+ });
116
+ }
117
+ }
3
118
 
4
119
  class CORSPlugin {
5
120
  options;
6
- constructor(options) {
121
+ order = 9e6;
122
+ constructor(options = {}) {
7
123
  const defaults = {
8
124
  origin: (origin) => origin,
9
125
  allowMethods: ["GET", "HEAD", "PUT", "POST", "DELETE", "PATCH"]
@@ -22,13 +138,11 @@ class CORSPlugin {
22
138
  resHeaders["access-control-max-age"] = this.options.maxAge.toString();
23
139
  }
24
140
  if (this.options.allowMethods?.length) {
25
- resHeaders["access-control-allow-methods"] = this.options.allowMethods.join(",");
141
+ resHeaders["access-control-allow-methods"] = flattenHeader(this.options.allowMethods);
26
142
  }
27
143
  const allowHeaders = this.options.allowHeaders ?? interceptorOptions.request.headers["access-control-request-headers"];
28
- if (Array.isArray(allowHeaders) && allowHeaders.length) {
29
- resHeaders["access-control-allow-headers"] = allowHeaders.join(",");
30
- } else if (typeof allowHeaders === "string") {
31
- resHeaders["access-control-allow-headers"] = allowHeaders;
144
+ if (typeof allowHeaders === "string" || allowHeaders?.length) {
145
+ resHeaders["access-control-allow-headers"] = flattenHeader(allowHeaders);
32
146
  }
33
147
  return {
34
148
  matched: true,
@@ -46,7 +160,7 @@ class CORSPlugin {
46
160
  if (!result.matched) {
47
161
  return result;
48
162
  }
49
- const origin = Array.isArray(interceptorOptions.request.headers.origin) ? interceptorOptions.request.headers.origin.join(",") : interceptorOptions.request.headers.origin || "";
163
+ const origin = flattenHeader(interceptorOptions.request.headers.origin) ?? "";
50
164
  const allowedOrigin = await value(this.options.origin, origin, interceptorOptions);
51
165
  const allowedOriginArr = Array.isArray(allowedOrigin) ? allowedOrigin : [allowedOrigin];
52
166
  if (allowedOriginArr.includes("*")) {
@@ -68,25 +182,46 @@ class CORSPlugin {
68
182
  result.response.headers["access-control-allow-credentials"] = "true";
69
183
  }
70
184
  if (this.options.exposeHeaders?.length) {
71
- result.response.headers["access-control-expose-headers"] = this.options.exposeHeaders.join(",");
185
+ result.response.headers["access-control-expose-headers"] = flattenHeader(this.options.exposeHeaders);
72
186
  }
73
187
  return result;
74
188
  });
75
189
  }
76
190
  }
77
191
 
192
+ class RequestHeadersPlugin {
193
+ init(options) {
194
+ options.rootInterceptors ??= [];
195
+ options.rootInterceptors.push((interceptorOptions) => {
196
+ const reqHeaders = interceptorOptions.context.reqHeaders ?? toFetchHeaders(interceptorOptions.request.headers);
197
+ return interceptorOptions.next({
198
+ ...interceptorOptions,
199
+ context: {
200
+ ...interceptorOptions.context,
201
+ reqHeaders
202
+ }
203
+ });
204
+ });
205
+ }
206
+ }
207
+
78
208
  class ResponseHeadersPlugin {
79
209
  init(options) {
80
210
  options.rootInterceptors ??= [];
81
211
  options.rootInterceptors.push(async (interceptorOptions) => {
82
- const headers = new Headers();
83
- interceptorOptions.context.resHeaders = headers;
84
- const result = await interceptorOptions.next();
212
+ const resHeaders = interceptorOptions.context.resHeaders ?? new Headers();
213
+ const result = await interceptorOptions.next({
214
+ ...interceptorOptions,
215
+ context: {
216
+ ...interceptorOptions.context,
217
+ resHeaders
218
+ }
219
+ });
85
220
  if (!result.matched) {
86
221
  return result;
87
222
  }
88
- const responseHeaders = result.response.headers;
89
- for (const [key, value] of headers) {
223
+ const responseHeaders = clone(result.response.headers);
224
+ for (const [key, value] of resHeaders) {
90
225
  if (Array.isArray(responseHeaders[key])) {
91
226
  responseHeaders[key].push(value);
92
227
  } else if (responseHeaders[key] !== void 0) {
@@ -95,9 +230,99 @@ class ResponseHeadersPlugin {
95
230
  responseHeaders[key] = value;
96
231
  }
97
232
  }
233
+ return {
234
+ ...result,
235
+ response: {
236
+ ...result.response,
237
+ headers: responseHeaders
238
+ }
239
+ };
240
+ });
241
+ }
242
+ }
243
+
244
+ class experimental_RethrowHandlerPlugin {
245
+ filter;
246
+ CONTEXT_SYMBOL = Symbol("ORPC_RETHROW_HANDLER_PLUGIN_CONTEXT");
247
+ constructor(options) {
248
+ this.filter = options.filter;
249
+ }
250
+ init(options) {
251
+ options.rootInterceptors ??= [];
252
+ options.interceptors ??= [];
253
+ options.rootInterceptors.push(async (options2) => {
254
+ const pluginContext = {};
255
+ const result = await options2.next({
256
+ ...options2,
257
+ context: {
258
+ ...options2.context,
259
+ [this.CONTEXT_SYMBOL]: pluginContext
260
+ }
261
+ });
262
+ if (pluginContext.error) {
263
+ throw pluginContext.error.value;
264
+ }
98
265
  return result;
99
266
  });
267
+ options.interceptors.unshift(async (options2) => {
268
+ const pluginContext = options2.context[this.CONTEXT_SYMBOL];
269
+ if (!pluginContext) {
270
+ throw new TypeError("[RethrowHandlerPlugin] Rethrow handler context has been corrupted or modified by another plugin or interceptor");
271
+ }
272
+ try {
273
+ return await options2.next();
274
+ } catch (error) {
275
+ if (value(this.filter, error, options2)) {
276
+ pluginContext.error = { value: error };
277
+ return { matched: false, response: void 0 };
278
+ }
279
+ throw error;
280
+ }
281
+ });
282
+ }
283
+ }
284
+
285
+ const SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL = Symbol("SIMPLE_CSRF_PROTECTION_CONTEXT");
286
+ class SimpleCsrfProtectionHandlerPlugin {
287
+ headerName;
288
+ headerValue;
289
+ exclude;
290
+ error;
291
+ constructor(options = {}) {
292
+ this.headerName = options.headerName ?? "x-csrf-token";
293
+ this.headerValue = options.headerValue ?? "orpc";
294
+ this.exclude = options.exclude ?? false;
295
+ this.error = options.error ?? new ORPCError("CSRF_TOKEN_MISMATCH", {
296
+ status: 403,
297
+ message: "Invalid CSRF token"
298
+ });
299
+ }
300
+ order = 8e6;
301
+ init(options) {
302
+ options.rootInterceptors ??= [];
303
+ options.clientInterceptors ??= [];
304
+ options.rootInterceptors.unshift(async (options2) => {
305
+ const headerName = await value(this.headerName, options2);
306
+ const headerValue = await value(this.headerValue, options2);
307
+ return options2.next({
308
+ ...options2,
309
+ context: {
310
+ ...options2.context,
311
+ [SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]: options2.request.headers[headerName] === headerValue
312
+ }
313
+ });
314
+ });
315
+ options.clientInterceptors.unshift(async (options2) => {
316
+ if (typeof options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL] !== "boolean") {
317
+ throw new TypeError("[SimpleCsrfProtectionHandlerPlugin] CSRF protection context has been corrupted or modified by another plugin or interceptor");
318
+ }
319
+ const excluded = await value(this.exclude, options2);
320
+ if (!excluded && !options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]) {
321
+ throw this.error;
322
+ }
323
+ return options2.next();
324
+ });
100
325
  }
101
326
  }
102
327
 
103
- export { CORSPlugin, ResponseHeadersPlugin };
328
+ export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, experimental_RethrowHandlerPlugin };
@@ -0,0 +1,74 @@
1
+ import { HTTPPath, ORPCError } from '@orpc/client';
2
+ import { Meta } from '@orpc/contract';
3
+ import { Interceptor } from '@orpc/shared';
4
+ import { StandardResponse, StandardLazyRequest } from '@orpc/standard-server';
5
+ import { C as Context, R as Router, b as AnyRouter, A as AnyProcedure, d as ProcedureClientInterceptorOptions } from './server.qKsRrdxW.js';
6
+
7
+ interface StandardHandlerPlugin<T extends Context> {
8
+ order?: number;
9
+ init?(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
10
+ }
11
+ declare class CompositeStandardHandlerPlugin<T extends Context, TPlugin extends StandardHandlerPlugin<T>> implements StandardHandlerPlugin<T> {
12
+ protected readonly plugins: TPlugin[];
13
+ constructor(plugins?: readonly TPlugin[]);
14
+ init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
15
+ }
16
+
17
+ type StandardParams = Record<string, string>;
18
+ type StandardMatchResult = {
19
+ path: readonly string[];
20
+ procedure: AnyProcedure;
21
+ params?: StandardParams;
22
+ } | undefined;
23
+ interface StandardMatcher {
24
+ init(router: AnyRouter): void;
25
+ match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
26
+ }
27
+ interface StandardCodec {
28
+ encode(output: unknown, procedure: AnyProcedure): StandardResponse;
29
+ encodeError(error: ORPCError<any, any>): StandardResponse;
30
+ decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
31
+ }
32
+
33
+ interface StandardHandleOptions<T extends Context> {
34
+ prefix?: HTTPPath;
35
+ context: T;
36
+ }
37
+ type StandardHandleResult = {
38
+ matched: true;
39
+ response: StandardResponse;
40
+ } | {
41
+ matched: false;
42
+ response: undefined;
43
+ };
44
+ interface StandardHandlerInterceptorOptions<T extends Context> extends StandardHandleOptions<T> {
45
+ request: StandardLazyRequest;
46
+ }
47
+ interface StandardHandlerOptions<TContext extends Context> {
48
+ plugins?: StandardHandlerPlugin<TContext>[];
49
+ /**
50
+ * Interceptors at the request level, helpful when you want catch errors
51
+ */
52
+ interceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, Promise<StandardHandleResult>>[];
53
+ /**
54
+ * Interceptors at the root level, helpful when you want override the request/response
55
+ */
56
+ rootInterceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, Promise<StandardHandleResult>>[];
57
+ /**
58
+ *
59
+ * Interceptors for procedure client.
60
+ */
61
+ clientInterceptors?: Interceptor<ProcedureClientInterceptorOptions<TContext, Record<never, never>, Meta>, Promise<unknown>>[];
62
+ }
63
+ declare class StandardHandler<T extends Context> {
64
+ private readonly matcher;
65
+ private readonly codec;
66
+ private readonly interceptors;
67
+ private readonly clientInterceptors;
68
+ private readonly rootInterceptors;
69
+ constructor(router: Router<any, T>, matcher: StandardMatcher, codec: StandardCodec, options: NoInfer<StandardHandlerOptions<T>>);
70
+ handle(request: StandardLazyRequest, options: StandardHandleOptions<T>): Promise<StandardHandleResult>;
71
+ }
72
+
73
+ export { CompositeStandardHandlerPlugin as C, StandardHandler as f };
74
+ export type { StandardCodec as S, StandardParams as a, StandardHandleOptions as b, StandardHandleResult as c, StandardHandlerInterceptorOptions as d, StandardHandlerOptions as e, StandardHandlerPlugin as g, StandardMatchResult as h, StandardMatcher as i };
@@ -0,0 +1,12 @@
1
+ import { C as Context } from './server.qKsRrdxW.mjs';
2
+ import { b as StandardHandleOptions } from './server.BqadksTP.mjs';
3
+
4
+ type FriendlyStandardHandleOptions<T extends Context> = Omit<StandardHandleOptions<T>, 'context'> & (Record<never, never> extends T ? {
5
+ context?: T;
6
+ } : {
7
+ context: T;
8
+ });
9
+ declare function resolveFriendlyStandardHandleOptions<T extends Context>(options: FriendlyStandardHandleOptions<T>): StandardHandleOptions<T>;
10
+
11
+ export { resolveFriendlyStandardHandleOptions as r };
12
+ export type { FriendlyStandardHandleOptions as F };