@orpc/server 0.0.0-next.6c5bfe4 → 0.0.0-next.6d0ea4a

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 (57) hide show
  1. package/README.md +27 -17
  2. package/dist/adapters/aws-lambda/index.d.mts +45 -0
  3. package/dist/adapters/aws-lambda/index.d.ts +45 -0
  4. package/dist/adapters/aws-lambda/index.mjs +41 -0
  5. package/dist/adapters/bun-ws/index.d.mts +35 -0
  6. package/dist/adapters/bun-ws/index.d.ts +35 -0
  7. package/dist/adapters/bun-ws/index.mjs +51 -0
  8. package/dist/adapters/crossws/index.d.mts +30 -0
  9. package/dist/adapters/crossws/index.d.ts +30 -0
  10. package/dist/adapters/crossws/index.mjs +51 -0
  11. package/dist/adapters/fetch/index.d.mts +62 -10
  12. package/dist/adapters/fetch/index.d.ts +62 -10
  13. package/dist/adapters/fetch/index.mjs +109 -8
  14. package/dist/adapters/message-port/index.d.mts +28 -0
  15. package/dist/adapters/message-port/index.d.ts +28 -0
  16. package/dist/adapters/message-port/index.mjs +41 -0
  17. package/dist/adapters/node/index.d.mts +64 -21
  18. package/dist/adapters/node/index.d.ts +64 -21
  19. package/dist/adapters/node/index.mjs +87 -23
  20. package/dist/adapters/standard/index.d.mts +11 -10
  21. package/dist/adapters/standard/index.d.ts +11 -10
  22. package/dist/adapters/standard/index.mjs +4 -3
  23. package/dist/adapters/websocket/index.d.mts +27 -0
  24. package/dist/adapters/websocket/index.d.ts +27 -0
  25. package/dist/adapters/websocket/index.mjs +38 -0
  26. package/dist/adapters/ws/index.d.mts +28 -0
  27. package/dist/adapters/ws/index.d.ts +28 -0
  28. package/dist/adapters/ws/index.mjs +38 -0
  29. package/dist/index.d.mts +626 -66
  30. package/dist/index.d.ts +626 -66
  31. package/dist/index.mjs +173 -37
  32. package/dist/plugins/index.d.mts +144 -19
  33. package/dist/plugins/index.d.ts +144 -19
  34. package/dist/plugins/index.mjs +163 -15
  35. package/dist/shared/server.-ACo36I0.d.ts +74 -0
  36. package/dist/shared/server.BPAWobQg.d.ts +12 -0
  37. package/dist/shared/server.BVwwTHyO.mjs +9 -0
  38. package/dist/shared/server.BW-nUGgA.mjs +36 -0
  39. package/dist/shared/server.Bd52nNaH.d.mts +12 -0
  40. package/dist/shared/server.BliFSTnG.d.mts +10 -0
  41. package/dist/shared/{server.N2ttmv6r.mjs → server.CHvOkcM3.mjs} +59 -31
  42. package/dist/shared/{server.CPteJIPP.d.mts → server.DD2C4ujN.d.mts} +73 -24
  43. package/dist/shared/{server.CPteJIPP.d.ts → server.DD2C4ujN.d.ts} +73 -24
  44. package/dist/shared/{server.kPUGzsdw.mjs → server.DG7Tamti.mjs} +42 -32
  45. package/dist/shared/server.Dq8xr7PQ.d.mts +74 -0
  46. package/dist/shared/server.IG2MjhrD.d.ts +10 -0
  47. package/package.json +54 -20
  48. package/dist/adapters/hono/index.d.mts +0 -19
  49. package/dist/adapters/hono/index.d.ts +0 -19
  50. package/dist/adapters/hono/index.mjs +0 -32
  51. package/dist/adapters/next/index.d.mts +0 -26
  52. package/dist/adapters/next/index.d.ts +0 -26
  53. package/dist/adapters/next/index.mjs +0 -29
  54. package/dist/shared/server.BZRSVRDu.d.ts +0 -77
  55. package/dist/shared/server.CXu_v2vM.mjs +0 -28
  56. package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
  57. package/dist/shared/server.iM8li30u.d.mts +0 -77
package/dist/index.mjs CHANGED
@@ -1,14 +1,17 @@
1
1
  import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter } from '@orpc/contract';
2
2
  export { ValidationError, eventIterator, type } from '@orpc/contract';
3
- import { P as Procedure, d as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, i as isProcedure, f as isLazy, h as createAssertedLazyProcedure, g as getRouter } from './shared/server.kPUGzsdw.mjs';
4
- export { L as LAZY_SYMBOL, k as call, o as createAccessibleLazyRouter, b as createContractedProcedure, n as getHiddenRouterContract, j as getLazyMeta, m as middlewareOutputFn, r as resolveContractProcedures, a as toHttpPath, t as traverseContractProcedures, u as unlazy, p as unlazyRouter } from './shared/server.kPUGzsdw.mjs';
3
+ import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure, g as getRouter } from './shared/server.DG7Tamti.mjs';
4
+ export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter, a as createContractedProcedure, h as createORPCErrorConstructorMap, q as getHiddenRouterContract, j as getLazyMeta, n as isStartWithMiddlewares, m as mergeCurrentContext, o as mergeMiddlewares, k as middlewareOutputFn, w as resolveContractProcedures, t as traverseContractProcedures, u as unlazy, x as unlazyRouter, v as validateORPCError } from './shared/server.DG7Tamti.mjs';
5
+ import { toORPCError } from '@orpc/client';
5
6
  export { ORPCError, isDefinedError, safe } from '@orpc/client';
7
+ import { resolveMaybeOptionalOptions } from '@orpc/shared';
6
8
  export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
7
9
  export { getEventMeta, withEventMeta } from '@orpc/standard-server';
8
10
 
9
11
  const DEFAULT_CONFIG = {
10
12
  initialInputValidationIndex: 0,
11
- initialOutputValidationIndex: 0
13
+ initialOutputValidationIndex: 0,
14
+ dedupeLeadingMiddlewares: true
12
15
  };
13
16
  function fallbackConfig(key, value) {
14
17
  if (value === void 0) {
@@ -18,7 +21,7 @@ function fallbackConfig(key, value) {
18
21
  }
19
22
 
20
23
  function decorateMiddleware(middleware) {
21
- const decorated = middleware;
24
+ const decorated = (...args) => middleware(...args);
22
25
  decorated.mapInput = (mapInput) => {
23
26
  const mapped = decorateMiddleware(
24
27
  (options, input, ...rest) => middleware(options, mapInput(input), ...rest)
@@ -43,19 +46,53 @@ function decorateMiddleware(middleware) {
43
46
  return decorated;
44
47
  }
45
48
 
49
+ function createActionableClient(client) {
50
+ const action = async (input) => {
51
+ try {
52
+ return [null, await client(input)];
53
+ } catch (error) {
54
+ if (error instanceof Error && "digest" in error && typeof error.digest === "string" && error.digest.startsWith("NEXT_")) {
55
+ throw error;
56
+ }
57
+ return [toORPCError(error).toJSON(), void 0];
58
+ }
59
+ };
60
+ return action;
61
+ }
62
+
46
63
  class DecoratedProcedure extends Procedure {
64
+ /**
65
+ * Adds type-safe custom errors.
66
+ * The provided errors are spared-merged with any existing errors.
67
+ *
68
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
69
+ */
47
70
  errors(errors) {
48
71
  return new DecoratedProcedure({
49
72
  ...this["~orpc"],
50
73
  errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
51
74
  });
52
75
  }
76
+ /**
77
+ * Sets or updates the metadata.
78
+ * The provided metadata is spared-merged with any existing metadata.
79
+ *
80
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
81
+ */
53
82
  meta(meta) {
54
83
  return new DecoratedProcedure({
55
84
  ...this["~orpc"],
56
85
  meta: mergeMeta(this["~orpc"].meta, meta)
57
86
  });
58
87
  }
88
+ /**
89
+ * Sets or updates the route definition.
90
+ * The provided route is spared-merged with any existing route.
91
+ * This option is typically relevant when integrating with OpenAPI.
92
+ *
93
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
94
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
95
+ */
59
96
  route(route) {
60
97
  return new DecoratedProcedure({
61
98
  ...this["~orpc"],
@@ -71,28 +108,51 @@ class DecoratedProcedure extends Procedure {
71
108
  }
72
109
  /**
73
110
  * Make this procedure callable (works like a function while still being a procedure).
111
+ *
112
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
74
113
  */
75
114
  callable(...rest) {
76
- return Object.assign(createProcedureClient(this, ...rest), {
77
- "~type": "Procedure",
78
- "~orpc": this["~orpc"]
115
+ const client = createProcedureClient(this, ...rest);
116
+ return new Proxy(client, {
117
+ get: (target, key) => {
118
+ return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
119
+ },
120
+ has: (target, key) => {
121
+ return Reflect.has(this, key) || Reflect.has(target, key);
122
+ }
79
123
  });
80
124
  }
81
125
  /**
82
- * Make this procedure compatible with server action (the same as .callable, but the type is compatible with server action).
126
+ * Make this procedure compatible with server action.
127
+ *
128
+ * @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
83
129
  */
84
130
  actionable(...rest) {
85
- return this.callable(...rest);
131
+ const action = createActionableClient(createProcedureClient(this, ...rest));
132
+ return new Proxy(action, {
133
+ get: (target, key) => {
134
+ return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
135
+ },
136
+ has: (target, key) => {
137
+ return Reflect.has(this, key) || Reflect.has(target, key);
138
+ }
139
+ });
86
140
  }
87
141
  }
88
142
 
89
143
  class Builder {
144
+ /**
145
+ * This property holds the defined options.
146
+ */
90
147
  "~orpc";
91
148
  constructor(def) {
92
149
  this["~orpc"] = def;
93
150
  }
94
151
  /**
95
- * Reset config
152
+ * Sets or overrides the config.
153
+ *
154
+ * @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
155
+ * @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
96
156
  */
97
157
  $config(config) {
98
158
  const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
@@ -100,12 +160,15 @@ class Builder {
100
160
  return new Builder({
101
161
  ...this["~orpc"],
102
162
  config,
163
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares),
103
164
  inputValidationIndex: fallbackConfig("initialInputValidationIndex", config.initialInputValidationIndex) + inputValidationCount,
104
165
  outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config.initialOutputValidationIndex) + outputValidationCount
105
166
  });
106
167
  }
107
168
  /**
108
- * Reset initial context
169
+ * Set or override the initial context.
170
+ *
171
+ * @see {@link https://orpc.unnoq.com/docs/context Context Docs}
109
172
  */
110
173
  $context() {
111
174
  return new Builder({
@@ -116,7 +179,9 @@ class Builder {
116
179
  });
117
180
  }
118
181
  /**
119
- * Reset initial meta
182
+ * Sets or overrides the initial meta.
183
+ *
184
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
120
185
  */
121
186
  $meta(initialMeta) {
122
187
  return new Builder({
@@ -125,7 +190,11 @@ class Builder {
125
190
  });
126
191
  }
127
192
  /**
128
- * Reset initial route
193
+ * Sets or overrides the initial route.
194
+ * This option is typically relevant when integrating with OpenAPI.
195
+ *
196
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
197
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
129
198
  */
130
199
  $route(initialRoute) {
131
200
  return new Builder({
@@ -133,15 +202,31 @@ class Builder {
133
202
  route: initialRoute
134
203
  });
135
204
  }
205
+ /**
206
+ * Sets or overrides the initial input schema.
207
+ *
208
+ * @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
209
+ */
136
210
  $input(initialInputSchema) {
137
211
  return new Builder({
138
212
  ...this["~orpc"],
139
213
  inputSchema: initialInputSchema
140
214
  });
141
215
  }
216
+ /**
217
+ * Creates a middleware.
218
+ *
219
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
220
+ */
142
221
  middleware(middleware) {
143
222
  return decorateMiddleware(middleware);
144
223
  }
224
+ /**
225
+ * Adds type-safe custom errors.
226
+ * The provided errors are spared-merged with any existing errors.
227
+ *
228
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
229
+ */
145
230
  errors(errors) {
146
231
  return new Builder({
147
232
  ...this["~orpc"],
@@ -155,18 +240,37 @@ class Builder {
155
240
  middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
156
241
  });
157
242
  }
243
+ /**
244
+ * Sets or updates the metadata.
245
+ * The provided metadata is spared-merged with any existing metadata.
246
+ *
247
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
248
+ */
158
249
  meta(meta) {
159
250
  return new Builder({
160
251
  ...this["~orpc"],
161
252
  meta: mergeMeta(this["~orpc"].meta, meta)
162
253
  });
163
254
  }
255
+ /**
256
+ * Sets or updates the route definition.
257
+ * The provided route is spared-merged with any existing route.
258
+ * This option is typically relevant when integrating with OpenAPI.
259
+ *
260
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
261
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
262
+ */
164
263
  route(route) {
165
264
  return new Builder({
166
265
  ...this["~orpc"],
167
266
  route: mergeRoute(this["~orpc"].route, route)
168
267
  });
169
268
  }
269
+ /**
270
+ * Defines the input validation schema.
271
+ *
272
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
273
+ */
170
274
  input(schema) {
171
275
  return new Builder({
172
276
  ...this["~orpc"],
@@ -174,6 +278,11 @@ class Builder {
174
278
  inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
175
279
  });
176
280
  }
281
+ /**
282
+ * Defines the output validation schema.
283
+ *
284
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
285
+ */
177
286
  output(schema) {
178
287
  return new Builder({
179
288
  ...this["~orpc"],
@@ -181,27 +290,57 @@ class Builder {
181
290
  outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
182
291
  });
183
292
  }
293
+ /**
294
+ * Defines the handler of the procedure.
295
+ *
296
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
297
+ */
184
298
  handler(handler) {
185
299
  return new DecoratedProcedure({
186
300
  ...this["~orpc"],
187
301
  handler
188
302
  });
189
303
  }
304
+ /**
305
+ * Prefixes all procedures in the router.
306
+ * The provided prefix is post-appended to any existing router prefix.
307
+ *
308
+ * @note This option does not affect procedures that do not define a path in their route definition.
309
+ *
310
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
311
+ */
190
312
  prefix(prefix) {
191
313
  return new Builder({
192
314
  ...this["~orpc"],
193
315
  prefix: mergePrefix(this["~orpc"].prefix, prefix)
194
316
  });
195
317
  }
318
+ /**
319
+ * Adds tags to all procedures in the router.
320
+ * This helpful when you want to group procedures together in the OpenAPI specification.
321
+ *
322
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
323
+ */
196
324
  tag(...tags) {
197
325
  return new Builder({
198
326
  ...this["~orpc"],
199
327
  tags: mergeTags(this["~orpc"].tags, tags)
200
328
  });
201
329
  }
330
+ /**
331
+ * Applies all of the previously defined options to the specified router.
332
+ *
333
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
334
+ */
202
335
  router(router) {
203
336
  return enhanceRouter(router, this["~orpc"]);
204
337
  }
338
+ /**
339
+ * Create a lazy router
340
+ * And applies all of the previously defined options to the specified router.
341
+ *
342
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
343
+ */
205
344
  lazy(loader) {
206
345
  return enhanceRouter(lazy(loader), this["~orpc"]);
207
346
  }
@@ -213,13 +352,10 @@ const os = new Builder({
213
352
  errorMap: {},
214
353
  inputValidationIndex: fallbackConfig("initialInputValidationIndex"),
215
354
  outputValidationIndex: fallbackConfig("initialOutputValidationIndex"),
216
- middlewares: []
355
+ middlewares: [],
356
+ dedupeLeadingMiddlewares: true
217
357
  });
218
358
 
219
- function mergeContext(context, other) {
220
- return { ...context, ...other };
221
- }
222
-
223
359
  function implementerInternal(contract, config, middlewares) {
224
360
  if (isContractProcedure(contract)) {
225
361
  const impl2 = new Builder({
@@ -227,7 +363,8 @@ function implementerInternal(contract, config, middlewares) {
227
363
  config,
228
364
  middlewares,
229
365
  inputValidationIndex: fallbackConfig("initialInputValidationIndex", config?.initialInputValidationIndex) + middlewares.length,
230
- outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length
366
+ outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length,
367
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
231
368
  });
232
369
  return impl2;
233
370
  }
@@ -253,7 +390,8 @@ function implementerInternal(contract, config, middlewares) {
253
390
  middlewares,
254
391
  errorMap: {},
255
392
  prefix: void 0,
256
- tags: void 0
393
+ tags: void 0,
394
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
257
395
  });
258
396
  return setHiddenRouterContract(adapted, contract);
259
397
  };
@@ -263,7 +401,8 @@ function implementerInternal(contract, config, middlewares) {
263
401
  middlewares,
264
402
  errorMap: {},
265
403
  prefix: void 0,
266
- tags: void 0
404
+ tags: void 0,
405
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
267
406
  });
268
407
  return setHiddenRouterContract(adapted, contract);
269
408
  };
@@ -296,28 +435,25 @@ function implement(contract, config = {}) {
296
435
  method = (config2) => implement(contract, config2);
297
436
  }
298
437
  const next = Reflect.get(target, key);
299
- if (!next || typeof next !== "function" && typeof next !== "object") {
300
- return method ?? next;
301
- }
302
- if (method) {
303
- return new Proxy(method, {
304
- get(_, key2) {
305
- return Reflect.get(next, key2);
306
- }
307
- });
438
+ if (!method || !next || typeof next !== "function" && typeof next !== "object") {
439
+ return method || next;
308
440
  }
309
- return next;
441
+ return new Proxy(method, {
442
+ get(_, key2) {
443
+ return Reflect.get(next, key2);
444
+ }
445
+ });
310
446
  }
311
447
  });
312
448
  return impl;
313
449
  }
314
450
 
315
- function createRouterClient(router, ...[options]) {
451
+ function createRouterClient(router, ...rest) {
316
452
  if (isProcedure(router)) {
317
- const caller = createProcedureClient(router, options);
453
+ const caller = createProcedureClient(router, resolveMaybeOptionalOptions(rest));
318
454
  return caller;
319
455
  }
320
- const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), options) : {};
456
+ const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), resolveMaybeOptionalOptions(rest)) : {};
321
457
  const recursive = new Proxy(procedureCaller, {
322
458
  get(target, key) {
323
459
  if (typeof key !== "string") {
@@ -328,12 +464,12 @@ function createRouterClient(router, ...[options]) {
328
464
  return Reflect.get(target, key);
329
465
  }
330
466
  return createRouterClient(next, {
331
- ...options,
332
- path: [...options?.path ?? [], key]
467
+ ...rest[0],
468
+ path: [...rest[0]?.path ?? [], key]
333
469
  });
334
470
  }
335
471
  });
336
472
  return recursive;
337
473
  }
338
474
 
339
- export { Builder, DecoratedProcedure, Procedure, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy, mergeContext, os, setHiddenRouterContract };
475
+ export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy, os, setHiddenRouterContract };
@@ -1,31 +1,156 @@
1
- import { a as StandardHandlerInterceptorOptions, H as HandlerPlugin, b as StandardHandlerOptions } from '../shared/server.iM8li30u.mjs';
2
- export { C as CompositePlugin } from '../shared/server.iM8li30u.mjs';
3
- import { Value } from '@orpc/shared';
4
- import { C as Context } from '../shared/server.CPteJIPP.mjs';
5
- import '@orpc/contract';
6
- import '@orpc/standard-server';
7
- import '@orpc/client';
1
+ import { Value, Promisable } from '@orpc/shared';
2
+ import { StandardRequest, StandardHeaders } from '@orpc/standard-server';
3
+ import { BatchResponseBodyItem } from '@orpc/standard-server/batch';
4
+ import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.Dq8xr7PQ.mjs';
5
+ import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DD2C4ujN.mjs';
6
+ import { Meta, ORPCError as ORPCError$1 } from '@orpc/contract';
7
+ import { ORPCError } from '@orpc/client';
8
8
 
9
- interface CORSOptions<TContext extends Context> {
10
- origin?: Value<string | string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<TContext>]>;
11
- timingOrigin?: Value<string | string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<TContext>]>;
12
- allowMethods?: string[];
13
- allowHeaders?: string[];
9
+ interface BatchHandlerOptions<T extends Context> {
10
+ /**
11
+ * The max size of the batch allowed.
12
+ *
13
+ * @default 10
14
+ */
15
+ maxSize?: Value<Promisable<number>, [StandardHandlerInterceptorOptions<T>]>;
16
+ /**
17
+ * Map the request before processing it.
18
+ *
19
+ * @default merged back batch request headers into the request
20
+ */
21
+ mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
22
+ /**
23
+ * Success batch response status code.
24
+ *
25
+ * @default 207
26
+ */
27
+ successStatus?: Value<Promisable<number>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
28
+ /**
29
+ * success batch response headers.
30
+ *
31
+ * @default {}
32
+ */
33
+ headers?: Value<Promisable<StandardHeaders>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
34
+ }
35
+ /**
36
+ * The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
37
+ * reducing the overhead of sending each one separately.
38
+ *
39
+ * @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
40
+ */
41
+ declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
42
+ private readonly maxSize;
43
+ private readonly mapRequestItem;
44
+ private readonly successStatus;
45
+ private readonly headers;
46
+ order: number;
47
+ constructor(options?: BatchHandlerOptions<T>);
48
+ init(options: StandardHandlerOptions<T>): void;
49
+ }
50
+
51
+ interface CORSOptions<T extends Context> {
52
+ origin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
53
+ timingOrigin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
54
+ allowMethods?: readonly string[];
55
+ allowHeaders?: readonly string[];
14
56
  maxAge?: number;
15
57
  credentials?: boolean;
16
- exposeHeaders?: string[];
58
+ exposeHeaders?: readonly string[];
17
59
  }
18
- declare class CORSPlugin<TContext extends Context> implements HandlerPlugin<TContext> {
60
+ /**
61
+ * CORSPlugin is a plugin for oRPC that allows you to configure CORS for your API.
62
+ *
63
+ * @see {@link https://orpc.unnoq.com/docs/plugins/cors CORS Plugin Docs}
64
+ */
65
+ declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
19
66
  private readonly options;
20
- constructor(options?: Partial<CORSOptions<TContext>>);
21
- init(options: StandardHandlerOptions<TContext>): void;
67
+ order: number;
68
+ constructor(options?: CORSOptions<T>);
69
+ init(options: StandardHandlerOptions<T>): void;
22
70
  }
23
71
 
24
72
  interface ResponseHeadersPluginContext {
25
73
  resHeaders?: Headers;
26
74
  }
27
- declare class ResponseHeadersPlugin<TContext extends ResponseHeadersPluginContext & Context> implements HandlerPlugin<TContext> {
28
- init(options: StandardHandlerOptions<TContext>): void;
75
+ /**
76
+ * The Response Headers Plugin allows you to set response headers in oRPC.
77
+ * It injects a resHeaders instance into the context, enabling you to modify response headers easily.
78
+ *
79
+ * @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
80
+ */
81
+ declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
82
+ init(options: StandardHandlerOptions<T>): void;
83
+ }
84
+
85
+ interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
86
+ /**
87
+ * The name of the header to check.
88
+ *
89
+ * @default 'x-csrf-token'
90
+ */
91
+ headerName?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
92
+ /**
93
+ * The value of the header to check.
94
+ *
95
+ * @default 'orpc'
96
+ *
97
+ */
98
+ headerValue?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
99
+ /**
100
+ * Exclude a procedure from the plugin.
101
+ *
102
+ * @default false
103
+ *
104
+ */
105
+ exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
106
+ /**
107
+ * The error thrown when the CSRF token is invalid.
108
+ *
109
+ * @default new ORPCError('CSRF_TOKEN_MISMATCH', {
110
+ * status: 403,
111
+ * message: 'Invalid CSRF token',
112
+ * })
113
+ */
114
+ error?: InstanceType<typeof ORPCError>;
115
+ }
116
+ /**
117
+ * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
118
+ * It helps ensure that requests to your procedures originate from JavaScript code,
119
+ * not from other sources like standard HTML forms or direct browser navigation.
120
+ *
121
+ * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
122
+ */
123
+ declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
124
+ private readonly headerName;
125
+ private readonly headerValue;
126
+ private readonly exclude;
127
+ private readonly error;
128
+ constructor(options?: SimpleCsrfProtectionHandlerPluginOptions<T>);
129
+ order: number;
130
+ init(options: StandardHandlerOptions<T>): void;
131
+ }
132
+
133
+ interface StrictGetMethodPluginOptions {
134
+ /**
135
+ * The error thrown when a GET request is made to a procedure that doesn't allow GET.
136
+ *
137
+ * @default new ORPCError('METHOD_NOT_SUPPORTED')
138
+ */
139
+ error?: InstanceType<typeof ORPCError$1>;
140
+ }
141
+ /**
142
+ * This plugin enhances security by ensuring only procedures explicitly marked to accept GET requests
143
+ * can be called using the HTTP GET method for RPC Protocol. This helps prevent certain types of
144
+ * Cross-Site Request Forgery (CSRF) attacks.
145
+ *
146
+ * @see {@link https://orpc.unnoq.com/docs/plugins/strict-get-method Strict Get Method Plugin Docs}
147
+ */
148
+ declare class StrictGetMethodPlugin<T extends Context> implements StandardHandlerPlugin<T> {
149
+ private readonly error;
150
+ order: number;
151
+ constructor(options?: StrictGetMethodPluginOptions);
152
+ init(options: StandardHandlerOptions<T>): void;
29
153
  }
30
154
 
31
- export { type CORSOptions, CORSPlugin, HandlerPlugin, ResponseHeadersPlugin, type ResponseHeadersPluginContext };
155
+ export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
156
+ export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };