@orpc/server 0.0.0-next.e0f01a5 → 0.0.0-next.e27e0c1

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 (63) hide show
  1. package/README.md +23 -23
  2. package/dist/adapters/aws-lambda/index.d.mts +46 -0
  3. package/dist/adapters/aws-lambda/index.d.ts +46 -0
  4. package/dist/adapters/aws-lambda/index.mjs +42 -0
  5. package/dist/adapters/bun-ws/index.d.mts +36 -0
  6. package/dist/adapters/bun-ws/index.d.ts +36 -0
  7. package/dist/adapters/bun-ws/index.mjs +47 -0
  8. package/dist/adapters/crossws/index.d.mts +33 -0
  9. package/dist/adapters/crossws/index.d.ts +33 -0
  10. package/dist/adapters/crossws/index.mjs +45 -0
  11. package/dist/adapters/fetch/index.d.mts +74 -9
  12. package/dist/adapters/fetch/index.d.ts +74 -9
  13. package/dist/adapters/fetch/index.mjs +80 -5
  14. package/dist/adapters/message-port/index.d.mts +57 -0
  15. package/dist/adapters/message-port/index.d.ts +57 -0
  16. package/dist/adapters/message-port/index.mjs +55 -0
  17. package/dist/adapters/node/index.d.mts +50 -9
  18. package/dist/adapters/node/index.d.ts +50 -9
  19. package/dist/adapters/node/index.mjs +76 -14
  20. package/dist/adapters/standard/index.d.mts +8 -13
  21. package/dist/adapters/standard/index.d.ts +8 -13
  22. package/dist/adapters/standard/index.mjs +5 -5
  23. package/dist/adapters/standard-peer/index.d.mts +18 -0
  24. package/dist/adapters/standard-peer/index.d.ts +18 -0
  25. package/dist/adapters/standard-peer/index.mjs +7 -0
  26. package/dist/adapters/websocket/index.d.mts +56 -0
  27. package/dist/adapters/websocket/index.d.ts +56 -0
  28. package/dist/adapters/websocket/index.mjs +67 -0
  29. package/dist/adapters/ws/index.d.mts +31 -0
  30. package/dist/adapters/ws/index.d.ts +31 -0
  31. package/dist/adapters/ws/index.mjs +37 -0
  32. package/dist/helpers/index.d.mts +149 -0
  33. package/dist/helpers/index.d.ts +149 -0
  34. package/dist/helpers/index.mjs +198 -0
  35. package/dist/hibernation/index.d.mts +44 -0
  36. package/dist/hibernation/index.d.ts +44 -0
  37. package/dist/hibernation/index.mjs +65 -0
  38. package/dist/index.d.mts +563 -52
  39. package/dist/index.d.ts +563 -52
  40. package/dist/index.mjs +142 -13
  41. package/dist/plugins/index.d.mts +60 -13
  42. package/dist/plugins/index.d.ts +60 -13
  43. package/dist/plugins/index.mjs +102 -67
  44. package/dist/shared/{server.BVHsfJ99.d.mts → server.B4BGqy3Y.d.mts} +60 -11
  45. package/dist/shared/{server.BVHsfJ99.d.ts → server.B4BGqy3Y.d.ts} +60 -11
  46. package/dist/shared/{server.DFuJLDuo.mjs → server.Bxx6tqNe.mjs} +80 -51
  47. package/dist/shared/server.COL12UTb.d.ts +32 -0
  48. package/dist/shared/server.CVKCo60T.d.mts +12 -0
  49. package/dist/shared/server.Cb6yD7DZ.d.ts +42 -0
  50. package/dist/shared/server.Ck-gOLzq.d.mts +32 -0
  51. package/dist/shared/{server.CaWivVk3.d.ts → server.DBCUJijK.d.mts} +11 -11
  52. package/dist/shared/server.DNtJ-p60.d.ts +12 -0
  53. package/dist/shared/{server.B1oIHH_j.d.mts → server.DPIFWpxG.d.ts} +11 -11
  54. package/dist/shared/{server.BVwwTHyO.mjs → server.DZ5BIITo.mjs} +1 -1
  55. package/dist/shared/{server.C37gDhSZ.mjs → server.Ds4HPpvH.mjs} +119 -74
  56. package/dist/shared/server.DzV1hr3z.d.mts +42 -0
  57. package/dist/shared/{server.BW-nUGgA.mjs → server.TEVCLCFC.mjs} +3 -0
  58. package/dist/shared/server.UVMTOWrk.mjs +26 -0
  59. package/package.json +75 -8
  60. package/dist/shared/server.BuLPHTX1.d.mts +0 -18
  61. package/dist/shared/server.DMhSfHk1.d.ts +0 -10
  62. package/dist/shared/server.D_vpYits.d.ts +0 -18
  63. package/dist/shared/server.Dwnm6cSk.d.mts +0 -10
@@ -1,7 +1,9 @@
1
- import { value, isAsyncIteratorObject } from '@orpc/shared';
1
+ import { runWithSpan, value, setSpanError, isAsyncIteratorObject, AsyncIteratorClass, clone } from '@orpc/shared';
2
+ import { flattenHeader } from '@orpc/standard-server';
2
3
  import { parseBatchRequest, toBatchResponse } from '@orpc/standard-server/batch';
4
+ import { toFetchHeaders } from '@orpc/standard-server-fetch';
3
5
  import { ORPCError } from '@orpc/client';
4
- export { S as StrictGetMethodPlugin } from '../shared/server.BW-nUGgA.mjs';
6
+ export { S as StrictGetMethodPlugin } from '../shared/server.TEVCLCFC.mjs';
5
7
  import '@orpc/contract';
6
8
 
7
9
  class BatchHandlerPlugin {
@@ -25,69 +27,82 @@ class BatchHandlerPlugin {
25
27
  init(options) {
26
28
  options.rootInterceptors ??= [];
27
29
  options.rootInterceptors.unshift(async (options2) => {
28
- if (options2.request.headers["x-orpc-batch"] !== "1") {
30
+ const xHeader = flattenHeader(options2.request.headers["x-orpc-batch"]);
31
+ if (xHeader === void 0) {
29
32
  return options2.next();
30
33
  }
31
34
  let isParsing = false;
32
35
  try {
33
- isParsing = true;
34
- const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
35
- isParsing = false;
36
- const maxSize = await value(this.maxSize, options2);
37
- if (parsed.length > maxSize) {
38
- return {
39
- matched: true,
40
- response: {
41
- status: 413,
42
- headers: {},
43
- body: "Batch request size exceeds the maximum allowed size"
44
- }
45
- };
46
- }
47
- const responses = parsed.map(
48
- (request, index) => {
49
- const mapped = this.mapRequestItem(request, options2);
50
- return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
51
- if (matched) {
52
- if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
53
- return {
54
- index,
55
- status: 500,
56
- headers: {},
57
- body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
58
- };
59
- }
60
- return { ...response2, index };
36
+ return await runWithSpan({ name: "handle_batch_request" }, async (span) => {
37
+ const mode = xHeader === "buffered" ? "buffered" : "streaming";
38
+ isParsing = true;
39
+ const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
40
+ isParsing = false;
41
+ span?.setAttribute("batch.mode", mode);
42
+ span?.setAttribute("batch.size", parsed.length);
43
+ const maxSize = await value(this.maxSize, options2);
44
+ if (parsed.length > maxSize) {
45
+ const message = "Batch request size exceeds the maximum allowed size";
46
+ setSpanError(span, message);
47
+ return {
48
+ matched: true,
49
+ response: {
50
+ status: 413,
51
+ headers: {},
52
+ body: message
61
53
  }
62
- return { index, status: 404, headers: {}, body: "No procedure matched" };
63
- }).catch(() => {
64
- return { index, status: 500, headers: {}, body: "Internal server error" };
65
- });
54
+ };
66
55
  }
67
- );
68
- await Promise.race(responses);
69
- const status = await value(this.successStatus, responses, options2);
70
- const headers = await value(this.headers, responses, options2);
71
- const response = toBatchResponse({
72
- status,
73
- headers,
74
- body: async function* () {
75
- const promises = [...responses];
76
- while (true) {
77
- const handling = promises.filter((p) => p !== void 0);
78
- if (handling.length === 0) {
79
- return;
80
- }
81
- const result = await Promise.race(handling);
82
- promises[result.index] = void 0;
83
- yield result;
56
+ const responses = parsed.map(
57
+ (request, index) => {
58
+ const mapped = this.mapRequestItem(request, options2);
59
+ return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
60
+ span?.addEvent(`response.${index}.${matched ? "success" : "not_matched"}`);
61
+ if (matched) {
62
+ if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
63
+ return {
64
+ index,
65
+ status: 500,
66
+ headers: {},
67
+ body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
68
+ };
69
+ }
70
+ return { ...response2, index };
71
+ }
72
+ return { index, status: 404, headers: {}, body: "No procedure matched" };
73
+ }).catch((err) => {
74
+ Promise.reject(err);
75
+ return { index, status: 500, headers: {}, body: "Internal server error" };
76
+ });
84
77
  }
85
- }()
78
+ );
79
+ await Promise.race(responses);
80
+ const status = await value(this.successStatus, responses, options2);
81
+ const headers = await value(this.headers, responses, options2);
82
+ const promises = [...responses];
83
+ const response = await toBatchResponse({
84
+ status,
85
+ headers,
86
+ mode,
87
+ body: new AsyncIteratorClass(
88
+ async () => {
89
+ const handling = promises.filter((p) => p !== void 0);
90
+ if (handling.length <= 0) {
91
+ return { done: true, value: void 0 };
92
+ }
93
+ const value2 = await Promise.race(handling);
94
+ promises[value2.index] = void 0;
95
+ return { done: false, value: value2 };
96
+ },
97
+ async () => {
98
+ }
99
+ )
100
+ });
101
+ return {
102
+ matched: true,
103
+ response
104
+ };
86
105
  });
87
- return {
88
- matched: true,
89
- response
90
- };
91
106
  } catch (cause) {
92
107
  if (isParsing) {
93
108
  return {
@@ -123,13 +138,11 @@ class CORSPlugin {
123
138
  resHeaders["access-control-max-age"] = this.options.maxAge.toString();
124
139
  }
125
140
  if (this.options.allowMethods?.length) {
126
- resHeaders["access-control-allow-methods"] = this.options.allowMethods.join(",");
141
+ resHeaders["access-control-allow-methods"] = flattenHeader(this.options.allowMethods);
127
142
  }
128
143
  const allowHeaders = this.options.allowHeaders ?? interceptorOptions.request.headers["access-control-request-headers"];
129
- if (Array.isArray(allowHeaders) && allowHeaders.length) {
130
- resHeaders["access-control-allow-headers"] = allowHeaders.join(",");
131
- } else if (typeof allowHeaders === "string") {
132
- resHeaders["access-control-allow-headers"] = allowHeaders;
144
+ if (typeof allowHeaders === "string" || allowHeaders?.length) {
145
+ resHeaders["access-control-allow-headers"] = flattenHeader(allowHeaders);
133
146
  }
134
147
  return {
135
148
  matched: true,
@@ -147,7 +160,7 @@ class CORSPlugin {
147
160
  if (!result.matched) {
148
161
  return result;
149
162
  }
150
- const origin = Array.isArray(interceptorOptions.request.headers.origin) ? interceptorOptions.request.headers.origin.join(",") : interceptorOptions.request.headers.origin || "";
163
+ const origin = flattenHeader(interceptorOptions.request.headers.origin) ?? "";
151
164
  const allowedOrigin = await value(this.options.origin, origin, interceptorOptions);
152
165
  const allowedOriginArr = Array.isArray(allowedOrigin) ? allowedOrigin : [allowedOrigin];
153
166
  if (allowedOriginArr.includes("*")) {
@@ -169,13 +182,29 @@ class CORSPlugin {
169
182
  result.response.headers["access-control-allow-credentials"] = "true";
170
183
  }
171
184
  if (this.options.exposeHeaders?.length) {
172
- result.response.headers["access-control-expose-headers"] = this.options.exposeHeaders.join(",");
185
+ result.response.headers["access-control-expose-headers"] = flattenHeader(this.options.exposeHeaders);
173
186
  }
174
187
  return result;
175
188
  });
176
189
  }
177
190
  }
178
191
 
192
+ class RequestHeadersPlugin {
193
+ init(options) {
194
+ options.rootInterceptors ??= [];
195
+ options.rootInterceptors.push((interceptorOptions) => {
196
+ const reqHeaders = interceptorOptions.context.reqHeaders ?? toFetchHeaders(interceptorOptions.request.headers);
197
+ return interceptorOptions.next({
198
+ ...interceptorOptions,
199
+ context: {
200
+ ...interceptorOptions.context,
201
+ reqHeaders
202
+ }
203
+ });
204
+ });
205
+ }
206
+ }
207
+
179
208
  class ResponseHeadersPlugin {
180
209
  init(options) {
181
210
  options.rootInterceptors ??= [];
@@ -191,7 +220,7 @@ class ResponseHeadersPlugin {
191
220
  if (!result.matched) {
192
221
  return result;
193
222
  }
194
- const responseHeaders = result.response.headers;
223
+ const responseHeaders = clone(result.response.headers);
195
224
  for (const [key, value] of resHeaders) {
196
225
  if (Array.isArray(responseHeaders[key])) {
197
226
  responseHeaders[key].push(value);
@@ -201,7 +230,13 @@ class ResponseHeadersPlugin {
201
230
  responseHeaders[key] = value;
202
231
  }
203
232
  }
204
- return result;
233
+ return {
234
+ ...result,
235
+ response: {
236
+ ...result.response,
237
+ headers: responseHeaders
238
+ }
239
+ };
205
240
  });
206
241
  }
207
242
  }
@@ -249,4 +284,4 @@ class SimpleCsrfProtectionHandlerPlugin {
249
284
  }
250
285
  }
251
286
 
252
- export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
287
+ export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
@@ -1,6 +1,6 @@
1
1
  import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
2
2
  import { ErrorMap, ErrorMapItem, InferSchemaInput, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
3
- import { MaybeOptionalOptions, Promisable, Interceptor, Value } from '@orpc/shared';
3
+ import { MaybeOptionalOptions, Promisable, Interceptor, PromiseWithError, Value } from '@orpc/shared';
4
4
 
5
5
  type Context = Record<PropertyKey, any>;
6
6
  type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
@@ -13,7 +13,6 @@ type ORPCErrorConstructorMap<T extends ErrorMap> = {
13
13
  [K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
14
14
  };
15
15
  declare function createORPCErrorConstructorMap<T extends ErrorMap>(errors: T): ORPCErrorConstructorMap<T>;
16
- declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
17
16
 
18
17
  declare const LAZY_SYMBOL: unique symbol;
19
18
  interface LazyMeta {
@@ -28,6 +27,11 @@ interface Lazy<T> {
28
27
  };
29
28
  }
30
29
  type Lazyable<T> = T | Lazy<T>;
30
+ /**
31
+ * Creates a lazy-loaded item.
32
+ *
33
+ * @warning The `prefix` in `meta` only holds metadata and does not apply the prefix to the lazy router, use `os.prefix(...).lazy(...)` instead.
34
+ */
31
35
  declare function lazy<T>(loader: () => Promise<{
32
36
  default: T;
33
37
  }>, meta?: LazyMeta): Lazy<T>;
@@ -56,7 +60,15 @@ interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends
56
60
  outputValidationIndex: number;
57
61
  handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
58
62
  }
63
+ /**
64
+ * This class represents a procedure.
65
+ *
66
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
67
+ */
59
68
  declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
69
+ /**
70
+ * This property holds the defined options.
71
+ */
60
72
  '~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
61
73
  constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
62
74
  }
@@ -87,6 +99,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
87
99
  next: MiddlewareNextFn<TOutput>;
88
100
  errors: TErrorConstructorMap;
89
101
  }
102
+ /**
103
+ * A function that represents a middleware.
104
+ *
105
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
106
+ */
90
107
  interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
91
108
  (options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
92
109
  }
@@ -106,39 +123,71 @@ interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TEr
106
123
  signal?: AbortSignal;
107
124
  lastEventId: string | undefined;
108
125
  }
109
- /**
110
- * Options for creating a procedure caller with comprehensive type safety
111
- */
112
126
  type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
113
127
  /**
114
128
  * This is helpful for logging and analytics.
115
129
  */
116
130
  path?: readonly string[];
117
- interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>[];
131
+ interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
118
132
  } & (Record<never, never> extends TInitialContext ? {
119
- context?: Value<TInitialContext, [clientContext: TClientContext]>;
133
+ context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
120
134
  } : {
121
- context: Value<TInitialContext, [clientContext: TClientContext]>;
135
+ context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
122
136
  });
123
- 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>;
137
+ /**
138
+ * Create Server-side client from a procedure.
139
+ *
140
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
141
+ */
142
+ 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>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
124
143
 
144
+ /**
145
+ * Represents a router, which defines a hierarchical structure of procedures.
146
+ *
147
+ * @info A procedure is a router too.
148
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
149
+ */
125
150
  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> : {
126
151
  [K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
127
152
  };
128
153
  type AnyRouter = Router<any, any>;
129
154
  type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
155
+ /**
156
+ * Infer all initial context of the router.
157
+ *
158
+ * @info A procedure is a router too.
159
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
160
+ */
130
161
  type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
131
162
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
132
163
  };
164
+ /**
165
+ * Infer all current context of the router.
166
+ *
167
+ * @info A procedure is a router too.
168
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
169
+ */
133
170
  type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
134
171
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
135
172
  };
173
+ /**
174
+ * Infer all router inputs
175
+ *
176
+ * @info A procedure is a router too.
177
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
178
+ */
136
179
  type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
137
180
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
138
181
  };
182
+ /**
183
+ * Infer all router outputs
184
+ *
185
+ * @info A procedure is a router too.
186
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
187
+ */
139
188
  type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
140
189
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
141
190
  };
142
191
 
143
- 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 };
144
- 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 };
192
+ export { isProcedure as E, createProcedureClient as F, Procedure as P, mergeCurrentContext as m, createORPCErrorConstructorMap as n, LAZY_SYMBOL as o, lazy as q, isLazy as r, getLazyMeta as s, unlazy as u, middlewareOutputFn as z };
193
+ export type { AnyProcedure as A, ProcedureHandlerOptions as B, Context as C, ProcedureDef as D, InferRouterInitialContexts as G, InferRouterCurrentContexts as H, InferRouterInitialContext as I, InferRouterInputs as J, InferRouterOutputs as K, Lazyable as L, MergedInitialContext as M, ORPCErrorConstructorMap as O, Router as R, AnyMiddleware as a, AnyRouter as b, Lazy as c, ProcedureClientInterceptorOptions as d, Middleware as e, MergedCurrentContext as f, MapInputMiddleware as g, CreateProcedureClientOptions as h, ProcedureClient as i, ProcedureHandler as j, ORPCErrorConstructorMapItemOptions as k, ORPCErrorConstructorMapItem as l, LazyMeta as p, MiddlewareResult as t, MiddlewareNextFnOptions as v, MiddlewareNextFn as w, MiddlewareOutputFn as x, MiddlewareOptions as y };
@@ -1,6 +1,6 @@
1
1
  import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
2
2
  import { ErrorMap, ErrorMapItem, InferSchemaInput, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
3
- import { MaybeOptionalOptions, Promisable, Interceptor, Value } from '@orpc/shared';
3
+ import { MaybeOptionalOptions, Promisable, Interceptor, PromiseWithError, Value } from '@orpc/shared';
4
4
 
5
5
  type Context = Record<PropertyKey, any>;
6
6
  type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
@@ -13,7 +13,6 @@ type ORPCErrorConstructorMap<T extends ErrorMap> = {
13
13
  [K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
14
14
  };
15
15
  declare function createORPCErrorConstructorMap<T extends ErrorMap>(errors: T): ORPCErrorConstructorMap<T>;
16
- declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
17
16
 
18
17
  declare const LAZY_SYMBOL: unique symbol;
19
18
  interface LazyMeta {
@@ -28,6 +27,11 @@ interface Lazy<T> {
28
27
  };
29
28
  }
30
29
  type Lazyable<T> = T | Lazy<T>;
30
+ /**
31
+ * Creates a lazy-loaded item.
32
+ *
33
+ * @warning The `prefix` in `meta` only holds metadata and does not apply the prefix to the lazy router, use `os.prefix(...).lazy(...)` instead.
34
+ */
31
35
  declare function lazy<T>(loader: () => Promise<{
32
36
  default: T;
33
37
  }>, meta?: LazyMeta): Lazy<T>;
@@ -56,7 +60,15 @@ interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends
56
60
  outputValidationIndex: number;
57
61
  handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
58
62
  }
63
+ /**
64
+ * This class represents a procedure.
65
+ *
66
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
67
+ */
59
68
  declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
69
+ /**
70
+ * This property holds the defined options.
71
+ */
60
72
  '~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
61
73
  constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
62
74
  }
@@ -87,6 +99,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
87
99
  next: MiddlewareNextFn<TOutput>;
88
100
  errors: TErrorConstructorMap;
89
101
  }
102
+ /**
103
+ * A function that represents a middleware.
104
+ *
105
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
106
+ */
90
107
  interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
91
108
  (options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
92
109
  }
@@ -106,39 +123,71 @@ interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TEr
106
123
  signal?: AbortSignal;
107
124
  lastEventId: string | undefined;
108
125
  }
109
- /**
110
- * Options for creating a procedure caller with comprehensive type safety
111
- */
112
126
  type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
113
127
  /**
114
128
  * This is helpful for logging and analytics.
115
129
  */
116
130
  path?: readonly string[];
117
- interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>[];
131
+ interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
118
132
  } & (Record<never, never> extends TInitialContext ? {
119
- context?: Value<TInitialContext, [clientContext: TClientContext]>;
133
+ context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
120
134
  } : {
121
- context: Value<TInitialContext, [clientContext: TClientContext]>;
135
+ context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
122
136
  });
123
- 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>;
137
+ /**
138
+ * Create Server-side client from a procedure.
139
+ *
140
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
141
+ */
142
+ 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>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
124
143
 
144
+ /**
145
+ * Represents a router, which defines a hierarchical structure of procedures.
146
+ *
147
+ * @info A procedure is a router too.
148
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
149
+ */
125
150
  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> : {
126
151
  [K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
127
152
  };
128
153
  type AnyRouter = Router<any, any>;
129
154
  type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
155
+ /**
156
+ * Infer all initial context of the router.
157
+ *
158
+ * @info A procedure is a router too.
159
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
160
+ */
130
161
  type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
131
162
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
132
163
  };
164
+ /**
165
+ * Infer all current context of the router.
166
+ *
167
+ * @info A procedure is a router too.
168
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
169
+ */
133
170
  type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
134
171
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
135
172
  };
173
+ /**
174
+ * Infer all router inputs
175
+ *
176
+ * @info A procedure is a router too.
177
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
178
+ */
136
179
  type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
137
180
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
138
181
  };
182
+ /**
183
+ * Infer all router outputs
184
+ *
185
+ * @info A procedure is a router too.
186
+ * @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
187
+ */
139
188
  type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
140
189
  [K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
141
190
  };
142
191
 
143
- 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 };
144
- 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 };
192
+ export { isProcedure as E, createProcedureClient as F, Procedure as P, mergeCurrentContext as m, createORPCErrorConstructorMap as n, LAZY_SYMBOL as o, lazy as q, isLazy as r, getLazyMeta as s, unlazy as u, middlewareOutputFn as z };
193
+ export type { AnyProcedure as A, ProcedureHandlerOptions as B, Context as C, ProcedureDef as D, InferRouterInitialContexts as G, InferRouterCurrentContexts as H, InferRouterInitialContext as I, InferRouterInputs as J, InferRouterOutputs as K, Lazyable as L, MergedInitialContext as M, ORPCErrorConstructorMap as O, Router as R, AnyMiddleware as a, AnyRouter as b, Lazy as c, ProcedureClientInterceptorOptions as d, Middleware as e, MergedCurrentContext as f, MapInputMiddleware as g, CreateProcedureClientOptions as h, ProcedureClient as i, ProcedureHandler as j, ORPCErrorConstructorMapItemOptions as k, ORPCErrorConstructorMapItem as l, LazyMeta as p, MiddlewareResult as t, MiddlewareNextFnOptions as v, MiddlewareNextFn as w, MiddlewareOutputFn as x, MiddlewareOptions as y };