@orpc/server 0.0.0-next.b45a533 → 0.0.0-next.b47b94e

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 (51) hide show
  1. package/README.md +25 -17
  2. package/dist/adapters/bun-ws/index.d.mts +35 -0
  3. package/dist/adapters/bun-ws/index.d.ts +35 -0
  4. package/dist/adapters/bun-ws/index.mjs +50 -0
  5. package/dist/adapters/crossws/index.d.mts +30 -0
  6. package/dist/adapters/crossws/index.d.ts +30 -0
  7. package/dist/adapters/crossws/index.mjs +50 -0
  8. package/dist/adapters/fetch/index.d.mts +62 -10
  9. package/dist/adapters/fetch/index.d.ts +62 -10
  10. package/dist/adapters/fetch/index.mjs +109 -8
  11. package/dist/adapters/node/index.d.mts +64 -21
  12. package/dist/adapters/node/index.d.ts +64 -21
  13. package/dist/adapters/node/index.mjs +87 -23
  14. package/dist/adapters/standard/index.d.mts +11 -10
  15. package/dist/adapters/standard/index.d.ts +11 -10
  16. package/dist/adapters/standard/index.mjs +3 -3
  17. package/dist/adapters/websocket/index.d.mts +27 -0
  18. package/dist/adapters/websocket/index.d.ts +27 -0
  19. package/dist/adapters/websocket/index.mjs +37 -0
  20. package/dist/adapters/ws/index.d.mts +28 -0
  21. package/dist/adapters/ws/index.d.ts +28 -0
  22. package/dist/adapters/ws/index.mjs +37 -0
  23. package/dist/index.d.mts +602 -51
  24. package/dist/index.d.ts +602 -51
  25. package/dist/index.mjs +147 -19
  26. package/dist/plugins/index.d.mts +140 -15
  27. package/dist/plugins/index.d.ts +140 -15
  28. package/dist/plugins/index.mjs +162 -14
  29. package/dist/shared/server.BRoxSiSC.d.mts +12 -0
  30. package/dist/shared/server.BVwwTHyO.mjs +9 -0
  31. package/dist/shared/server.BW-nUGgA.mjs +36 -0
  32. package/dist/shared/server.BjiJH9Vo.d.ts +10 -0
  33. package/dist/shared/server.Cy1vfSiG.d.ts +12 -0
  34. package/dist/shared/{server.B_5ZADvP.mjs → server.DG7Tamti.mjs} +26 -22
  35. package/dist/shared/{server.DnmJuN02.d.mts → server.DPWk5pjW.d.mts} +61 -13
  36. package/dist/shared/{server.DnmJuN02.d.ts → server.DPWk5pjW.d.ts} +61 -13
  37. package/dist/shared/server.QUe9N8P4.d.mts +10 -0
  38. package/dist/shared/{server.3mOimouH.mjs → server.SxlTJfG2.mjs} +55 -30
  39. package/dist/shared/server.YZzrREz9.d.ts +74 -0
  40. package/dist/shared/server.eWLxY3lq.d.mts +74 -0
  41. package/package.json +43 -20
  42. package/dist/adapters/hono/index.d.mts +0 -19
  43. package/dist/adapters/hono/index.d.ts +0 -19
  44. package/dist/adapters/hono/index.mjs +0 -32
  45. package/dist/adapters/next/index.d.mts +0 -26
  46. package/dist/adapters/next/index.d.ts +0 -26
  47. package/dist/adapters/next/index.mjs +0 -29
  48. package/dist/shared/server.BgDZnmUZ.mjs +0 -28
  49. package/dist/shared/server.CL84X8p4.d.mts +0 -75
  50. package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
  51. package/dist/shared/server.hqPWnakL.d.ts +0 -75
@@ -1,8 +1,110 @@
1
- export { C as CompositePlugin } from '../shared/server.Q6ZmnTgO.mjs';
2
- import { value } from '@orpc/shared';
1
+ import { value, isAsyncIteratorObject } from '@orpc/shared';
2
+ import { parseBatchRequest, toBatchResponse } from '@orpc/standard-server/batch';
3
+ import { flattenHeader } from '@orpc/standard-server';
4
+ import { ORPCError } from '@orpc/client';
5
+ export { S as StrictGetMethodPlugin } from '../shared/server.BW-nUGgA.mjs';
6
+ import '@orpc/contract';
7
+
8
+ class BatchHandlerPlugin {
9
+ maxSize;
10
+ mapRequestItem;
11
+ successStatus;
12
+ headers;
13
+ order = 5e6;
14
+ constructor(options = {}) {
15
+ this.maxSize = options.maxSize ?? 10;
16
+ this.mapRequestItem = options.mapRequestItem ?? ((request, { request: batchRequest }) => ({
17
+ ...request,
18
+ headers: {
19
+ ...batchRequest.headers,
20
+ ...request.headers
21
+ }
22
+ }));
23
+ this.successStatus = options.successStatus ?? 207;
24
+ this.headers = options.headers ?? {};
25
+ }
26
+ init(options) {
27
+ options.rootInterceptors ??= [];
28
+ options.rootInterceptors.unshift(async (options2) => {
29
+ if (options2.request.headers["x-orpc-batch"] !== "1") {
30
+ return options2.next();
31
+ }
32
+ let isParsing = false;
33
+ try {
34
+ isParsing = true;
35
+ const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
36
+ isParsing = false;
37
+ const maxSize = await value(this.maxSize, options2);
38
+ if (parsed.length > maxSize) {
39
+ return {
40
+ matched: true,
41
+ response: {
42
+ status: 413,
43
+ headers: {},
44
+ body: "Batch request size exceeds the maximum allowed size"
45
+ }
46
+ };
47
+ }
48
+ const responses = parsed.map(
49
+ (request, index) => {
50
+ const mapped = this.mapRequestItem(request, options2);
51
+ return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
52
+ if (matched) {
53
+ if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
54
+ return {
55
+ index,
56
+ status: 500,
57
+ headers: {},
58
+ body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
59
+ };
60
+ }
61
+ return { ...response2, index };
62
+ }
63
+ return { index, status: 404, headers: {}, body: "No procedure matched" };
64
+ }).catch(() => {
65
+ return { index, status: 500, headers: {}, body: "Internal server error" };
66
+ });
67
+ }
68
+ );
69
+ await Promise.race(responses);
70
+ const status = await value(this.successStatus, responses, options2);
71
+ const headers = await value(this.headers, responses, options2);
72
+ const response = toBatchResponse({
73
+ status,
74
+ headers,
75
+ body: async function* () {
76
+ const promises = [...responses];
77
+ while (true) {
78
+ const handling = promises.filter((p) => p !== void 0);
79
+ if (handling.length === 0) {
80
+ return;
81
+ }
82
+ const result = await Promise.race(handling);
83
+ promises[result.index] = void 0;
84
+ yield result;
85
+ }
86
+ }()
87
+ });
88
+ return {
89
+ matched: true,
90
+ response
91
+ };
92
+ } catch (cause) {
93
+ if (isParsing) {
94
+ return {
95
+ matched: true,
96
+ response: { status: 400, headers: {}, body: "Invalid batch request, this could be caused by a malformed request body or a missing header" }
97
+ };
98
+ }
99
+ throw cause;
100
+ }
101
+ });
102
+ }
103
+ }
3
104
 
4
105
  class CORSPlugin {
5
106
  options;
107
+ order = 9e6;
6
108
  constructor(options = {}) {
7
109
  const defaults = {
8
110
  origin: (origin) => origin,
@@ -22,13 +124,11 @@ class CORSPlugin {
22
124
  resHeaders["access-control-max-age"] = this.options.maxAge.toString();
23
125
  }
24
126
  if (this.options.allowMethods?.length) {
25
- resHeaders["access-control-allow-methods"] = this.options.allowMethods.join(",");
127
+ resHeaders["access-control-allow-methods"] = flattenHeader(this.options.allowMethods);
26
128
  }
27
129
  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;
130
+ if (typeof allowHeaders === "string" || allowHeaders?.length) {
131
+ resHeaders["access-control-allow-headers"] = flattenHeader(allowHeaders);
32
132
  }
33
133
  return {
34
134
  matched: true,
@@ -46,7 +146,7 @@ class CORSPlugin {
46
146
  if (!result.matched) {
47
147
  return result;
48
148
  }
49
- const origin = Array.isArray(interceptorOptions.request.headers.origin) ? interceptorOptions.request.headers.origin.join(",") : interceptorOptions.request.headers.origin || "";
149
+ const origin = flattenHeader(interceptorOptions.request.headers.origin) ?? "";
50
150
  const allowedOrigin = await value(this.options.origin, origin, interceptorOptions);
51
151
  const allowedOriginArr = Array.isArray(allowedOrigin) ? allowedOrigin : [allowedOrigin];
52
152
  if (allowedOriginArr.includes("*")) {
@@ -68,7 +168,7 @@ class CORSPlugin {
68
168
  result.response.headers["access-control-allow-credentials"] = "true";
69
169
  }
70
170
  if (this.options.exposeHeaders?.length) {
71
- result.response.headers["access-control-expose-headers"] = this.options.exposeHeaders.join(",");
171
+ result.response.headers["access-control-expose-headers"] = flattenHeader(this.options.exposeHeaders);
72
172
  }
73
173
  return result;
74
174
  });
@@ -79,14 +179,19 @@ class ResponseHeadersPlugin {
79
179
  init(options) {
80
180
  options.rootInterceptors ??= [];
81
181
  options.rootInterceptors.push(async (interceptorOptions) => {
82
- const headers = new Headers();
83
- interceptorOptions.context.resHeaders = headers;
84
- const result = await interceptorOptions.next();
182
+ const resHeaders = interceptorOptions.context.resHeaders ?? new Headers();
183
+ const result = await interceptorOptions.next({
184
+ ...interceptorOptions,
185
+ context: {
186
+ ...interceptorOptions.context,
187
+ resHeaders
188
+ }
189
+ });
85
190
  if (!result.matched) {
86
191
  return result;
87
192
  }
88
193
  const responseHeaders = result.response.headers;
89
- for (const [key, value] of headers) {
194
+ for (const [key, value] of resHeaders) {
90
195
  if (Array.isArray(responseHeaders[key])) {
91
196
  responseHeaders[key].push(value);
92
197
  } else if (responseHeaders[key] !== void 0) {
@@ -100,4 +205,47 @@ class ResponseHeadersPlugin {
100
205
  }
101
206
  }
102
207
 
103
- export { CORSPlugin, ResponseHeadersPlugin };
208
+ const SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL = Symbol("SIMPLE_CSRF_PROTECTION_CONTEXT");
209
+ class SimpleCsrfProtectionHandlerPlugin {
210
+ headerName;
211
+ headerValue;
212
+ exclude;
213
+ error;
214
+ constructor(options = {}) {
215
+ this.headerName = options.headerName ?? "x-csrf-token";
216
+ this.headerValue = options.headerValue ?? "orpc";
217
+ this.exclude = options.exclude ?? false;
218
+ this.error = options.error ?? new ORPCError("CSRF_TOKEN_MISMATCH", {
219
+ status: 403,
220
+ message: "Invalid CSRF token"
221
+ });
222
+ }
223
+ order = 8e6;
224
+ init(options) {
225
+ options.rootInterceptors ??= [];
226
+ options.clientInterceptors ??= [];
227
+ options.rootInterceptors.unshift(async (options2) => {
228
+ const headerName = await value(this.headerName, options2);
229
+ const headerValue = await value(this.headerValue, options2);
230
+ return options2.next({
231
+ ...options2,
232
+ context: {
233
+ ...options2.context,
234
+ [SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]: options2.request.headers[headerName] === headerValue
235
+ }
236
+ });
237
+ });
238
+ options.clientInterceptors.unshift(async (options2) => {
239
+ if (typeof options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL] !== "boolean") {
240
+ throw new TypeError("[SimpleCsrfProtectionHandlerPlugin] CSRF protection context has been corrupted or modified by another plugin or interceptor");
241
+ }
242
+ const excluded = await value(this.exclude, options2);
243
+ if (!excluded && !options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]) {
244
+ throw this.error;
245
+ }
246
+ return options2.next();
247
+ });
248
+ }
249
+ }
250
+
251
+ export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
@@ -0,0 +1,12 @@
1
+ import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
2
+ import { C as Context, R as Router } from './server.DPWk5pjW.mjs';
3
+ import { b as StandardHandlerOptions, i as StandardHandler } from './server.eWLxY3lq.mjs';
4
+
5
+ interface StandardRPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardRPCJsonSerializerOptions {
6
+ }
7
+ declare class StandardRPCHandler<T extends Context> extends StandardHandler<T> {
8
+ constructor(router: Router<any, T>, options?: StandardRPCHandlerOptions<T>);
9
+ }
10
+
11
+ export { StandardRPCHandler as a };
12
+ export type { StandardRPCHandlerOptions as S };
@@ -0,0 +1,9 @@
1
+ function resolveFriendlyStandardHandleOptions(options) {
2
+ return {
3
+ ...options,
4
+ context: options?.context ?? {}
5
+ // Context only optional if all fields are optional
6
+ };
7
+ }
8
+
9
+ export { resolveFriendlyStandardHandleOptions as r };
@@ -0,0 +1,36 @@
1
+ import { ORPCError, fallbackContractConfig } from '@orpc/contract';
2
+
3
+ const STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL = Symbol("STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT");
4
+ class StrictGetMethodPlugin {
5
+ error;
6
+ order = 7e6;
7
+ constructor(options = {}) {
8
+ this.error = options.error ?? new ORPCError("METHOD_NOT_SUPPORTED");
9
+ }
10
+ init(options) {
11
+ options.rootInterceptors ??= [];
12
+ options.clientInterceptors ??= [];
13
+ options.rootInterceptors.unshift((options2) => {
14
+ const isGetMethod = options2.request.method === "GET";
15
+ return options2.next({
16
+ ...options2,
17
+ context: {
18
+ ...options2.context,
19
+ [STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL]: isGetMethod
20
+ }
21
+ });
22
+ });
23
+ options.clientInterceptors.unshift((options2) => {
24
+ if (typeof options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] !== "boolean") {
25
+ throw new TypeError("[StrictGetMethodPlugin] strict GET method context has been corrupted or modified by another plugin or interceptor");
26
+ }
27
+ const procedureMethod = fallbackContractConfig("defaultMethod", options2.procedure["~orpc"].route.method);
28
+ if (options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] && procedureMethod !== "GET") {
29
+ throw this.error;
30
+ }
31
+ return options2.next();
32
+ });
33
+ }
34
+ }
35
+
36
+ export { StrictGetMethodPlugin as S };
@@ -0,0 +1,10 @@
1
+ import { C as Context } from './server.DPWk5pjW.js';
2
+ import { g as StandardHandleOptions } from './server.YZzrREz9.js';
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
+
10
+ export type { FriendlyStandardHandleOptions as F };
@@ -0,0 +1,12 @@
1
+ import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
2
+ import { C as Context, R as Router } from './server.DPWk5pjW.js';
3
+ import { b as StandardHandlerOptions, i as StandardHandler } from './server.YZzrREz9.js';
4
+
5
+ interface StandardRPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardRPCJsonSerializerOptions {
6
+ }
7
+ declare class StandardRPCHandler<T extends Context> extends StandardHandler<T> {
8
+ constructor(router: Router<any, T>, options?: StandardRPCHandlerOptions<T>);
9
+ }
10
+
11
+ export { StandardRPCHandler as a };
12
+ export type { StandardRPCHandlerOptions as S };
@@ -1,6 +1,6 @@
1
1
  import { isContractProcedure, ValidationError, mergePrefix, mergeErrorMap, enhanceRoute } from '@orpc/contract';
2
2
  import { fallbackORPCErrorStatus, ORPCError } from '@orpc/client';
3
- import { value, intercept, toError } from '@orpc/shared';
3
+ import { value, intercept } from '@orpc/shared';
4
4
 
5
5
  const LAZY_SYMBOL = Symbol("ORPC_LAZY_SYMBOL");
6
6
  function lazy(loader, meta = {}) {
@@ -46,6 +46,9 @@ function addMiddleware(middlewares, addition) {
46
46
  }
47
47
 
48
48
  class Procedure {
49
+ /**
50
+ * This property holds the defined options.
51
+ */
49
52
  "~orpc";
50
53
  constructor(def) {
51
54
  this["~orpc"] = def;
@@ -58,6 +61,10 @@ function isProcedure(item) {
58
61
  return isContractProcedure(item) && "middlewares" in item["~orpc"] && "inputValidationIndex" in item["~orpc"] && "outputValidationIndex" in item["~orpc"] && "handler" in item["~orpc"];
59
62
  }
60
63
 
64
+ function mergeCurrentContext(context, other) {
65
+ return { ...context, ...other };
66
+ }
67
+
61
68
  function createORPCErrorConstructorMap(errors) {
62
69
  const proxy = new Proxy(errors, {
63
70
  get(target, code) {
@@ -123,7 +130,7 @@ function createProcedureClient(lazyableProcedure, ...[options]) {
123
130
  );
124
131
  } catch (e) {
125
132
  if (!(e instanceof ORPCError)) {
126
- throw toError(e);
133
+ throw e;
127
134
  }
128
135
  const validated = await validateORPCError(procedure["~orpc"].errorMap, e);
129
136
  throw validated;
@@ -165,28 +172,29 @@ async function executeProcedureInternal(procedure, options) {
165
172
  const middlewares = procedure["~orpc"].middlewares;
166
173
  const inputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].inputValidationIndex), middlewares.length);
167
174
  const outputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].outputValidationIndex), middlewares.length);
168
- let currentIndex = 0;
169
- let currentContext = options.context;
170
- let currentInput = options.input;
171
- const next = async (...[nextOptions]) => {
172
- const index = currentIndex;
173
- currentIndex += 1;
174
- currentContext = { ...currentContext, ...nextOptions?.context };
175
+ const next = async (index, context, input) => {
176
+ let currentInput = input;
175
177
  if (index === inputValidationIndex) {
176
178
  currentInput = await validateInput(procedure, currentInput);
177
179
  }
178
180
  const mid = middlewares[index];
179
- const result = mid ? await mid({ ...options, context: currentContext, next }, currentInput, middlewareOutputFn) : { output: await procedure["~orpc"].handler({ ...options, context: currentContext, input: currentInput }), context: currentContext };
181
+ const output = mid ? (await mid({
182
+ ...options,
183
+ context,
184
+ next: async (...[nextOptions]) => {
185
+ const nextContext = nextOptions?.context ?? {};
186
+ return {
187
+ output: await next(index + 1, mergeCurrentContext(context, nextContext), currentInput),
188
+ context: nextContext
189
+ };
190
+ }
191
+ }, currentInput, middlewareOutputFn)).output : await procedure["~orpc"].handler({ ...options, context, input: currentInput });
180
192
  if (index === outputValidationIndex) {
181
- const validatedOutput = await validateOutput(procedure, result.output);
182
- return {
183
- ...result,
184
- output: validatedOutput
185
- };
193
+ return await validateOutput(procedure, output);
186
194
  }
187
- return result;
195
+ return output;
188
196
  };
189
- return (await next({})).output;
197
+ return next(0, options.context, options.input);
190
198
  }
191
199
 
192
200
  const HIDDEN_ROUTER_CONTRACT_SYMBOL = Symbol("ORPC_HIDDEN_ROUTER_CONTRACT");
@@ -356,8 +364,4 @@ function call(procedure, input, ...rest) {
356
364
  return createProcedureClient(procedure, ...rest)(input);
357
365
  }
358
366
 
359
- function toHttpPath(path) {
360
- return `/${path.map(encodeURIComponent).join("/")}`;
361
- }
362
-
363
- export { LAZY_SYMBOL as L, Procedure as P, toHttpPath as a, createContractedProcedure as b, createProcedureClient as c, addMiddleware as d, enhanceRouter as e, isLazy as f, getRouter as g, createAssertedLazyProcedure as h, isProcedure as i, createORPCErrorConstructorMap as j, getLazyMeta as k, lazy as l, middlewareOutputFn as m, isStartWithMiddlewares as n, mergeMiddlewares as o, call as p, getHiddenRouterContract as q, createAccessibleLazyRouter as r, setHiddenRouterContract as s, traverseContractProcedures as t, unlazy as u, validateORPCError as v, resolveContractProcedures as w, unlazyRouter as x };
367
+ export { LAZY_SYMBOL as L, Procedure as P, createContractedProcedure as a, addMiddleware as b, createProcedureClient as c, isLazy as d, enhanceRouter as e, createAssertedLazyProcedure as f, getRouter as g, createORPCErrorConstructorMap as h, isProcedure as i, getLazyMeta as j, middlewareOutputFn as k, lazy as l, mergeCurrentContext as m, isStartWithMiddlewares as n, mergeMiddlewares as o, call as p, getHiddenRouterContract as q, createAccessibleLazyRouter as r, setHiddenRouterContract as s, traverseContractProcedures as t, unlazy as u, validateORPCError as v, resolveContractProcedures as w, unlazyRouter as x };
@@ -1,12 +1,11 @@
1
- import { ORPCErrorCode, ORPCErrorOptions, ORPCError, ClientContext, Client } from '@orpc/client';
1
+ import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
2
+ import { ErrorMap, ErrorMapItem, InferSchemaInput, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
2
3
  import { MaybeOptionalOptions, Promisable, Interceptor, Value } from '@orpc/shared';
3
- import { ErrorMap, ErrorMapItem, InferSchemaInput, HTTPPath, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
4
4
 
5
- type Context = Record<string, any>;
5
+ type Context = Record<PropertyKey, any>;
6
6
  type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
7
7
  type MergedCurrentContext<T extends Context, U extends Context> = Omit<T, keyof U> & U;
8
8
  declare function mergeCurrentContext<T extends Context, U extends Context>(context: T, other: U): MergedCurrentContext<T, U>;
9
- type ContextExtendsGuard<T extends Context, U extends Context> = T extends T & U ? unknown : never;
10
9
 
11
10
  type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
12
11
  type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
@@ -29,6 +28,9 @@ interface Lazy<T> {
29
28
  };
30
29
  }
31
30
  type Lazyable<T> = T | Lazy<T>;
31
+ /**
32
+ * Create a lazy thing.
33
+ */
32
34
  declare function lazy<T>(loader: () => Promise<{
33
35
  default: T;
34
36
  }>, meta?: LazyMeta): Lazy<T>;
@@ -57,7 +59,15 @@ interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends
57
59
  outputValidationIndex: number;
58
60
  handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
59
61
  }
62
+ /**
63
+ * This class represents a procedure.
64
+ *
65
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
66
+ */
60
67
  declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
68
+ /**
69
+ * This property holds the defined options.
70
+ */
61
71
  '~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
62
72
  constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
63
73
  }
@@ -88,6 +98,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
88
98
  next: MiddlewareNextFn<TOutput>;
89
99
  errors: TErrorConstructorMap;
90
100
  }
101
+ /**
102
+ * A function that represents a middleware.
103
+ *
104
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
105
+ */
91
106
  interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
92
107
  (options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
93
108
  }
@@ -98,47 +113,80 @@ interface MapInputMiddleware<TInput, TMappedInput> {
98
113
  declare function middlewareOutputFn<TOutput>(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
99
114
 
100
115
  type ProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
101
- interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
116
+ interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
102
117
  context: TInitialContext;
103
- input: InferSchemaInput<TInputSchema>;
118
+ input: unknown;
104
119
  errors: ORPCErrorConstructorMap<TErrorMap>;
105
120
  path: readonly string[];
106
121
  procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
107
122
  signal?: AbortSignal;
108
123
  lastEventId: string | undefined;
109
124
  }
110
- /**
111
- * Options for creating a procedure caller with comprehensive type safety
112
- */
113
- type CreateProcedureClientOptions<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
125
+ type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
114
126
  /**
115
127
  * This is helpful for logging and analytics.
116
128
  */
117
129
  path?: readonly string[];
118
- interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TInputSchema, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>[];
130
+ interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>[];
119
131
  } & (Record<never, never> extends TInitialContext ? {
120
132
  context?: Value<TInitialContext, [clientContext: TClientContext]>;
121
133
  } : {
122
134
  context: Value<TInitialContext, [clientContext: TClientContext]>;
123
135
  });
124
- declare function createProcedureClient<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...[options]: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
136
+ /**
137
+ * Create Server-side client from a procedure.
138
+ *
139
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
140
+ */
141
+ declare function createProcedureClient<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...[options]: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
125
142
 
143
+ /**
144
+ * Represents a router, which defines a hierarchical structure of procedures.
145
+ *
146
+ * @info A procedure is a router too.
147
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
148
+ */
126
149
  type Router<T extends AnyContractRouter, TInitialContext extends Context> = T extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? Procedure<TInitialContext, any, UInputSchema, UOutputSchema, UErrorMap, UMeta> : {
127
150
  [K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
128
151
  };
129
152
  type AnyRouter = Router<any, any>;
130
153
  type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
154
+ /**
155
+ * Infer all initial context of the router.
156
+ *
157
+ * @info A procedure is a router too.
158
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
159
+ */
131
160
  type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
132
161
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
133
162
  };
163
+ /**
164
+ * Infer all current context of the router.
165
+ *
166
+ * @info A procedure is a router too.
167
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
168
+ */
134
169
  type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
135
170
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
136
171
  };
172
+ /**
173
+ * Infer all router inputs
174
+ *
175
+ * @info A procedure is a router too.
176
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
177
+ */
137
178
  type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
138
179
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
139
180
  };
181
+ /**
182
+ * Infer all router outputs
183
+ *
184
+ * @info A procedure is a router too.
185
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
186
+ */
140
187
  type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
141
188
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
142
189
  };
143
190
 
144
- export { type AnyProcedure as A, type MiddlewareOptions as B, type Context as C, middlewareOutputFn as D, type ProcedureHandlerOptions as E, type ProcedureDef as F, isProcedure as G, createProcedureClient as H, type InferRouterInitialContext as I, type InferRouterInitialContexts as J, type InferRouterCurrentContexts as K, type Lazyable as L, type Middleware as M, type InferRouterInputs as N, type ORPCErrorConstructorMap as O, type ProcedureClientInterceptorOptions as P, type InferRouterOutputs as Q, type Router as R, type AnyRouter as a, Procedure as b, type ContextExtendsGuard as c, type MergedCurrentContext as d, type MergedInitialContext as e, type MapInputMiddleware as f, type CreateProcedureClientOptions as g, type ProcedureClient as h, type AnyMiddleware as i, type Lazy as j, type ProcedureHandler as k, type ORPCErrorConstructorMapItemOptions as l, mergeCurrentContext as m, type ORPCErrorConstructorMapItem as n, createORPCErrorConstructorMap as o, LAZY_SYMBOL as p, type LazyMeta as q, lazy as r, isLazy as s, getLazyMeta as t, unlazy as u, validateORPCError as v, type MiddlewareResult as w, type MiddlewareNextFnOptions as x, type MiddlewareNextFn as y, type MiddlewareOutputFn as z };
191
+ export { isProcedure as E, createProcedureClient as G, Procedure as P, createORPCErrorConstructorMap as l, mergeCurrentContext as m, LAZY_SYMBOL as n, lazy as p, isLazy as q, getLazyMeta as r, unlazy as u, validateORPCError as v, middlewareOutputFn as z };
192
+ export type { AnyMiddleware as A, ProcedureHandlerOptions as B, Context as C, ProcedureDef as D, ProcedureClientInterceptorOptions as F, InferRouterInitialContexts as H, InferRouterInitialContext as I, InferRouterCurrentContexts as J, InferRouterInputs as K, Lazyable as L, Middleware as M, InferRouterOutputs as N, ORPCErrorConstructorMap as O, Router as R, MergedInitialContext as a, MergedCurrentContext as b, MapInputMiddleware as c, CreateProcedureClientOptions as d, ProcedureClient as e, AnyRouter as f, Lazy as g, AnyProcedure as h, ProcedureHandler as i, ORPCErrorConstructorMapItemOptions as j, ORPCErrorConstructorMapItem as k, LazyMeta as o, MiddlewareResult as s, MiddlewareNextFnOptions as t, MiddlewareNextFn as w, MiddlewareOutputFn as x, MiddlewareOptions as y };