@orpc/server 0.0.0-next.93e6063 → 0.0.0-next.93fa264

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 (64) hide show
  1. package/README.md +28 -20
  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 +46 -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 +46 -0
  11. package/dist/adapters/fetch/index.d.mts +62 -11
  12. package/dist/adapters/fetch/index.d.ts +62 -11
  13. package/dist/adapters/fetch/index.mjs +108 -7
  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 -22
  18. package/dist/adapters/node/index.d.ts +64 -22
  19. package/dist/adapters/node/index.mjs +86 -21
  20. package/dist/adapters/standard/index.d.mts +12 -15
  21. package/dist/adapters/standard/index.d.ts +12 -15
  22. package/dist/adapters/standard/index.mjs +4 -4
  23. package/dist/adapters/websocket/index.d.mts +51 -0
  24. package/dist/adapters/websocket/index.d.ts +51 -0
  25. package/dist/adapters/websocket/index.mjs +69 -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 +39 -0
  29. package/dist/hibernation/index.d.mts +44 -0
  30. package/dist/hibernation/index.d.ts +44 -0
  31. package/dist/hibernation/index.mjs +65 -0
  32. package/dist/index.d.mts +711 -132
  33. package/dist/index.d.ts +711 -132
  34. package/dist/index.mjs +207 -52
  35. package/dist/plugins/index.d.mts +144 -19
  36. package/dist/plugins/index.d.ts +144 -19
  37. package/dist/plugins/index.mjs +165 -15
  38. package/dist/shared/server.-ACo36I0.d.ts +74 -0
  39. package/dist/shared/server.BPAWobQg.d.ts +12 -0
  40. package/dist/shared/server.BW-nUGgA.mjs +36 -0
  41. package/dist/shared/server.Bd52nNaH.d.mts +12 -0
  42. package/dist/shared/server.BliFSTnG.d.mts +10 -0
  43. package/dist/shared/{server.BBGuTxHE.mjs → server.CHvOkcM3.mjs} +69 -46
  44. package/dist/shared/server.DD2C4ujN.d.mts +192 -0
  45. package/dist/shared/server.DD2C4ujN.d.ts +192 -0
  46. package/dist/shared/{server.V6zT5iYQ.mjs → server.DG7Tamti.mjs} +161 -173
  47. package/dist/shared/server.DZ5BIITo.mjs +9 -0
  48. package/dist/shared/server.Dq8xr7PQ.d.mts +74 -0
  49. package/dist/shared/server.IG2MjhrD.d.ts +10 -0
  50. package/package.json +59 -20
  51. package/dist/adapters/hono/index.d.mts +0 -20
  52. package/dist/adapters/hono/index.d.ts +0 -20
  53. package/dist/adapters/hono/index.mjs +0 -32
  54. package/dist/adapters/next/index.d.mts +0 -27
  55. package/dist/adapters/next/index.d.ts +0 -27
  56. package/dist/adapters/next/index.mjs +0 -29
  57. package/dist/shared/server.B-ewprcf.d.ts +0 -77
  58. package/dist/shared/server.CA-o8cUY.d.mts +0 -9
  59. package/dist/shared/server.Cn9ybJtE.d.mts +0 -152
  60. package/dist/shared/server.Cn9ybJtE.d.ts +0 -152
  61. package/dist/shared/server.DJrh0Ceu.d.mts +0 -77
  62. package/dist/shared/server.DPQt9YYq.d.ts +0 -9
  63. package/dist/shared/server.KwueCzFr.mjs +0 -26
  64. package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
package/dist/index.mjs CHANGED
@@ -1,14 +1,17 @@
1
- import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure } from '@orpc/contract';
1
+ import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter, fallbackContractConfig } from '@orpc/contract';
2
2
  export { ValidationError, eventIterator, type } from '@orpc/contract';
3
- import { P as Procedure, d as addMiddleware, c as createProcedureClient, f as adaptRouter, h as flatLazy, l as lazy, s as setRouterContract, i as isProcedure, j as isLazy, k as createLazyProcedureFormAnyLazy, g as getRouterChild } from './shared/server.V6zT5iYQ.mjs';
4
- export { L as LAZY_LOADER_SYMBOL, a as convertPathToHttpPath, q as createAccessibleLazyRouter, b as createContractedProcedure, n as deepSetLazyRouterPrefix, r as eachAllContractProcedure, e as eachContractProcedure, o as getLazyRouterPrefix, m as getRouterContract, p as middlewareOutputFn, u as unlazy } from './shared/server.V6zT5iYQ.mjs';
3
+ import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, u as unlazy, g as getRouter, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure } 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, 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';
6
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
7
+ import { resolveMaybeOptionalOptions } from '@orpc/shared';
8
+ export { EventPublisher, 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,9 +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
+ */
210
+ $input(initialInputSchema) {
211
+ return new Builder({
212
+ ...this["~orpc"],
213
+ inputSchema: initialInputSchema
214
+ });
215
+ }
216
+ /**
217
+ * Creates a middleware.
218
+ *
219
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
220
+ */
136
221
  middleware(middleware) {
137
222
  return decorateMiddleware(middleware);
138
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
+ */
139
230
  errors(errors) {
140
231
  return new Builder({
141
232
  ...this["~orpc"],
@@ -149,18 +240,37 @@ class Builder {
149
240
  middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
150
241
  });
151
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
+ */
152
249
  meta(meta) {
153
250
  return new Builder({
154
251
  ...this["~orpc"],
155
252
  meta: mergeMeta(this["~orpc"].meta, meta)
156
253
  });
157
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
+ */
158
263
  route(route) {
159
264
  return new Builder({
160
265
  ...this["~orpc"],
161
266
  route: mergeRoute(this["~orpc"].route, route)
162
267
  });
163
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
+ */
164
274
  input(schema) {
165
275
  return new Builder({
166
276
  ...this["~orpc"],
@@ -168,6 +278,11 @@ class Builder {
168
278
  inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
169
279
  });
170
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
+ */
171
286
  output(schema) {
172
287
  return new Builder({
173
288
  ...this["~orpc"],
@@ -175,29 +290,59 @@ class Builder {
175
290
  outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
176
291
  });
177
292
  }
293
+ /**
294
+ * Defines the handler of the procedure.
295
+ *
296
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
297
+ */
178
298
  handler(handler) {
179
299
  return new DecoratedProcedure({
180
300
  ...this["~orpc"],
181
301
  handler
182
302
  });
183
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
+ */
184
312
  prefix(prefix) {
185
313
  return new Builder({
186
314
  ...this["~orpc"],
187
315
  prefix: mergePrefix(this["~orpc"].prefix, prefix)
188
316
  });
189
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
+ */
190
324
  tag(...tags) {
191
325
  return new Builder({
192
326
  ...this["~orpc"],
193
327
  tags: mergeTags(this["~orpc"].tags, tags)
194
328
  });
195
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
+ */
196
335
  router(router) {
197
- return adaptRouter(router, this["~orpc"]);
336
+ return enhanceRouter(router, this["~orpc"]);
198
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
+ */
199
344
  lazy(loader) {
200
- return adaptRouter(flatLazy(lazy(loader)), this["~orpc"]);
345
+ return enhanceRouter(lazy(loader), this["~orpc"]);
201
346
  }
202
347
  }
203
348
  const os = new Builder({
@@ -205,17 +350,12 @@ const os = new Builder({
205
350
  route: {},
206
351
  meta: {},
207
352
  errorMap: {},
208
- inputSchema: void 0,
209
- outputSchema: void 0,
210
353
  inputValidationIndex: fallbackConfig("initialInputValidationIndex"),
211
354
  outputValidationIndex: fallbackConfig("initialOutputValidationIndex"),
212
- middlewares: []
355
+ middlewares: [],
356
+ dedupeLeadingMiddlewares: true
213
357
  });
214
358
 
215
- function mergeContext(context, other) {
216
- return { ...context, ...other };
217
- }
218
-
219
359
  function implementerInternal(contract, config, middlewares) {
220
360
  if (isContractProcedure(contract)) {
221
361
  const impl2 = new Builder({
@@ -223,12 +363,16 @@ function implementerInternal(contract, config, middlewares) {
223
363
  config,
224
364
  middlewares,
225
365
  inputValidationIndex: fallbackConfig("initialInputValidationIndex", config?.initialInputValidationIndex) + middlewares.length,
226
- outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length
366
+ outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length,
367
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
227
368
  });
228
369
  return impl2;
229
370
  }
230
371
  const impl = new Proxy(contract, {
231
372
  get: (target, key) => {
373
+ if (typeof key !== "string") {
374
+ return Reflect.get(target, key);
375
+ }
232
376
  let method;
233
377
  if (key === "middleware") {
234
378
  method = (mid) => decorateMiddleware(mid);
@@ -242,23 +386,29 @@ function implementerInternal(contract, config, middlewares) {
242
386
  };
243
387
  } else if (key === "router") {
244
388
  method = (router) => {
245
- const adapted = adaptRouter(router, {
389
+ const adapted = enhanceRouter(router, {
246
390
  middlewares,
247
- errorMap: {}
391
+ errorMap: {},
392
+ prefix: void 0,
393
+ tags: void 0,
394
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
248
395
  });
249
- return setRouterContract(adapted, contract);
396
+ return setHiddenRouterContract(adapted, contract);
250
397
  };
251
398
  } else if (key === "lazy") {
252
399
  method = (loader) => {
253
- const adapted = adaptRouter(flatLazy(lazy(loader)), {
400
+ const adapted = enhanceRouter(lazy(loader), {
254
401
  middlewares,
255
- errorMap: {}
402
+ errorMap: {},
403
+ prefix: void 0,
404
+ tags: void 0,
405
+ dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
256
406
  });
257
- return setRouterContract(adapted, contract);
407
+ return setHiddenRouterContract(adapted, contract);
258
408
  };
259
409
  }
260
- const next = Reflect.get(target, key);
261
- if (!next || typeof next !== "function" && typeof next !== "object") {
410
+ const next = getContractRouter(target, [key]);
411
+ if (!next) {
262
412
  return method ?? next;
263
413
  }
264
414
  const nextImpl = implementerInternal(next, config, middlewares);
@@ -285,49 +435,54 @@ function implement(contract, config = {}) {
285
435
  method = (config2) => implement(contract, config2);
286
436
  }
287
437
  const next = Reflect.get(target, key);
288
- if (!next || typeof next !== "function" && typeof next !== "object") {
289
- return method ?? next;
438
+ if (!method || !next || typeof next !== "function" && typeof next !== "object") {
439
+ return method || next;
290
440
  }
291
- if (method) {
292
- return new Proxy(method, {
293
- get(_, key2) {
294
- return Reflect.get(next, key2);
295
- }
296
- });
297
- }
298
- return next;
441
+ return new Proxy(method, {
442
+ get(_, key2) {
443
+ return Reflect.get(next, key2);
444
+ }
445
+ });
299
446
  }
300
447
  });
301
448
  return impl;
302
449
  }
303
450
 
304
- function call(procedure, input, ...rest) {
305
- return createProcedureClient(procedure, ...rest)(input);
451
+ function inferRPCMethodFromRouter(router) {
452
+ return async (_, path) => {
453
+ const { default: procedure } = await unlazy(getRouter(router, path));
454
+ if (!isProcedure(procedure)) {
455
+ throw new Error(
456
+ `[inferRPCMethodFromRouter] No valid procedure found at path "${path.join(".")}". This may happen when the router is not properly configured.`
457
+ );
458
+ }
459
+ const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
460
+ return method === "HEAD" ? "GET" : method;
461
+ };
306
462
  }
307
463
 
308
464
  function createRouterClient(router, ...rest) {
309
465
  if (isProcedure(router)) {
310
- const caller = createProcedureClient(router, ...rest);
466
+ const caller = createProcedureClient(router, resolveMaybeOptionalOptions(rest));
311
467
  return caller;
312
468
  }
313
- const procedureCaller = isLazy(router) ? createProcedureClient(createLazyProcedureFormAnyLazy(router), ...rest) : {};
469
+ const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), resolveMaybeOptionalOptions(rest)) : {};
314
470
  const recursive = new Proxy(procedureCaller, {
315
471
  get(target, key) {
316
472
  if (typeof key !== "string") {
317
473
  return Reflect.get(target, key);
318
474
  }
319
- const next = getRouterChild(router, key);
475
+ const next = getRouter(router, [key]);
320
476
  if (!next) {
321
477
  return Reflect.get(target, key);
322
478
  }
323
- const [options] = rest;
324
479
  return createRouterClient(next, {
325
- ...options,
326
- path: [...options?.path ?? [], key]
480
+ ...rest[0],
481
+ path: [...rest[0]?.path ?? [], key]
327
482
  });
328
483
  }
329
484
  });
330
485
  return recursive;
331
486
  }
332
487
 
333
- export { Builder, DecoratedProcedure, Procedure, adaptRouter, call, createLazyProcedureFormAnyLazy, createProcedureClient, createRouterClient, decorateMiddleware, fallbackConfig, flatLazy, getRouterChild, implement, implementerInternal, isLazy, isProcedure, lazy, mergeContext, os, setRouterContract };
488
+ export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, inferRPCMethodFromRouter, isLazy, isProcedure, lazy, os, setHiddenRouterContract, unlazy };
@@ -1,31 +1,156 @@
1
- import { d as StandardHandlerInterceptorOptions, P as Plugin, a as StandardHandlerOptions } from '../shared/server.DJrh0Ceu.mjs';
2
- export { C as CompositePlugin } from '../shared/server.DJrh0Ceu.mjs';
3
- import { Value } from '@orpc/shared';
4
- import { C as Context } from '../shared/server.Cn9ybJtE.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 Requests 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-requests Batch Requests 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 Plugin<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 Plugin<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, Plugin, ResponseHeadersPlugin, type ResponseHeadersPluginContext };
155
+ export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
156
+ export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };