@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
package/dist/index.d.ts CHANGED
@@ -1,27 +1,83 @@
1
- import { AnySchema, ErrorMap, Meta, MergedErrorMap, Route, InferSchemaOutput, InferSchemaInput, EnhanceRouteOptions, AnyContractRouter, AnyContractProcedure, Schema, HTTPPath, ContractRouter, ContractProcedureDef, ContractProcedure, InferContractRouterErrorMap, InferContractRouterMeta, ErrorFromErrorMap } from '@orpc/contract';
2
- export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, HTTPMethod, HTTPPath, InferSchemaInput, InferSchemaOutput, InputStructure, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type } from '@orpc/contract';
3
- import { C as Context, b as Procedure, M as Middleware, O as ORPCErrorConstructorMap, c as ContextExtendsGuard, d as MergedCurrentContext, e as MergedInitialContext, f as MapInputMiddleware, g as CreateProcedureClientOptions, h as ProcedureClient, i as AnyMiddleware, L as Lazyable, a as AnyRouter, j as Lazy, A as AnyProcedure, k as ProcedureHandler, R as Router, I as InferRouterInitialContext } from './shared/server.DnmJuN02.js';
4
- export { K as InferRouterCurrentContexts, J as InferRouterInitialContexts, N as InferRouterInputs, Q as InferRouterOutputs, p as LAZY_SYMBOL, q as LazyMeta, y as MiddlewareNextFn, x as MiddlewareNextFnOptions, B as MiddlewareOptions, z as MiddlewareOutputFn, w as MiddlewareResult, n as ORPCErrorConstructorMapItem, l as ORPCErrorConstructorMapItemOptions, P as ProcedureClientInterceptorOptions, F as ProcedureDef, E as ProcedureHandlerOptions, o as createORPCErrorConstructorMap, H as createProcedureClient, t as getLazyMeta, s as isLazy, G as isProcedure, r as lazy, m as mergeCurrentContext, D as middlewareOutputFn, u as unlazy, v as validateORPCError } from './shared/server.DnmJuN02.js';
5
- import { ClientContext, ClientRest, ClientPromiseResult } from '@orpc/client';
6
- export { ORPCError, isDefinedError, safe } from '@orpc/client';
7
- import { MaybeOptionalOptions } from '@orpc/shared';
8
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, ClientPromiseResult } from '@orpc/client';
2
+ export { ClientContext, HTTPMethod, HTTPPath, ORPCError, isDefinedError, safe } from '@orpc/client';
3
+ import { AnySchema, ErrorMap, InferSchemaInput, InferSchemaOutput, ErrorFromErrorMap, Meta, MergedErrorMap, Route, EnhanceRouteOptions, AnyContractRouter, AnyContractProcedure, Schema, ContractRouter, ContractProcedureDef, ContractProcedure, InferContractRouterErrorMap, InferContractRouterMeta } from '@orpc/contract';
4
+ export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type } from '@orpc/contract';
5
+ import { ThrowableError, IntersectPick, MaybeOptionalOptions } from '@orpc/shared';
6
+ export { IntersectPick, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
7
+ import { C as Context, P as Procedure, M as Middleware, O as ORPCErrorConstructorMap, a as MergedInitialContext, b as MergedCurrentContext, c as MapInputMiddleware, d as CreateProcedureClientOptions, e as ProcedureClient, A as AnyMiddleware, L as Lazyable, f as AnyRouter, g as Lazy, h as AnyProcedure, i as ProcedureHandler, R as Router, I as InferRouterInitialContext } from './shared/server.DPWk5pjW.js';
8
+ export { J as InferRouterCurrentContexts, H as InferRouterInitialContexts, K as InferRouterInputs, N as InferRouterOutputs, n as LAZY_SYMBOL, o as LazyMeta, w as MiddlewareNextFn, t as MiddlewareNextFnOptions, y as MiddlewareOptions, x as MiddlewareOutputFn, s as MiddlewareResult, k as ORPCErrorConstructorMapItem, j as ORPCErrorConstructorMapItemOptions, F as ProcedureClientInterceptorOptions, D as ProcedureDef, B as ProcedureHandlerOptions, l as createORPCErrorConstructorMap, G as createProcedureClient, r as getLazyMeta, q as isLazy, E as isProcedure, p as lazy, m as mergeCurrentContext, z as middlewareOutputFn, u as unlazy, v as validateORPCError } from './shared/server.DPWk5pjW.js';
9
9
  export { getEventMeta, withEventMeta } from '@orpc/standard-server';
10
10
 
11
+ type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
12
+ defined: true;
13
+ } : ORPCErrorJSON<string, unknown> & {
14
+ defined: false;
15
+ };
16
+ type UnactionableError<T> = T extends {
17
+ defined: true;
18
+ } & ORPCErrorJSON<infer U, infer V> ? ORPCError<U, V> : ThrowableError;
19
+ type ActionableClientRest<TInput> = [input: TInput] | (undefined extends TInput ? [input?: TInput] : [input: TInput]);
20
+ type ActionableClientResult<TOutput, TError extends ORPCErrorJSON<any, any>> = [error: null, data: TOutput] | [error: TError, data: undefined];
21
+ interface ActionableClient<TInput, TOutput, TError extends ORPCErrorJSON<any, any>> {
22
+ (...rest: ActionableClientRest<TInput>): Promise<ActionableClientResult<TOutput, TError>>;
23
+ }
24
+ type ProcedureActionableClient<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = ActionableClient<InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ActionableError<ErrorFromErrorMap<TErrorMap>>>;
25
+ declare function createActionableClient<TInput, TOutput, TError>(client: Client<Record<never, never>, TInput, TOutput, TError>): ActionableClient<TInput, TOutput, ActionableError<TError>>;
26
+
11
27
  declare class DecoratedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> {
28
+ /**
29
+ * Adds type-safe custom errors.
30
+ * The provided errors are spared-merged with any existing errors.
31
+ *
32
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
33
+ */
12
34
  errors<U extends ErrorMap>(errors: U): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
35
+ /**
36
+ * Sets or updates the metadata.
37
+ * The provided metadata is spared-merged with any existing metadata.
38
+ *
39
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
40
+ */
13
41
  meta(meta: TMeta): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
42
+ /**
43
+ * Sets or updates the route definition.
44
+ * The provided route is spared-merged with any existing route.
45
+ * This option is typically relevant when integrating with OpenAPI.
46
+ *
47
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
48
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
49
+ */
14
50
  route(route: Route): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
15
- use<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ContextExtendsGuard<MergedCurrentContext<TCurrentContext, UOutContext>, TCurrentContext> & DecoratedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
16
- use<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & ContextExtendsGuard<MergedCurrentContext<TCurrentContext, UOutContext>, TCurrentContext> & DecoratedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
51
+ /**
52
+ * Uses a middleware to modify the context or improve the pipeline.
53
+ *
54
+ * @info Supports both normal middleware and inline middleware implementations.
55
+ * @info Pass second argument to map the input.
56
+ * @note The current context must be satisfy middleware dependent-context
57
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
58
+ */
59
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): DecoratedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
60
+ /**
61
+ * Uses a middleware to modify the context or improve the pipeline.
62
+ *
63
+ * @info Supports both normal middleware and inline middleware implementations.
64
+ * @info Pass second argument to map the input.
65
+ * @note The current context must be satisfy middleware dependent-context
66
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
67
+ */
68
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): DecoratedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
17
69
  /**
18
70
  * Make this procedure callable (works like a function while still being a procedure).
71
+ *
72
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
19
73
  */
20
- callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
74
+ callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
21
75
  /**
22
- * Make this procedure compatible with server action (the same as .callable, but the type is compatible with server action).
76
+ * Make this procedure compatible with server action.
77
+ *
78
+ * @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
23
79
  */
24
- actionable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ((...rest: ClientRest<TClientContext, InferSchemaInput<TInputSchema>>) => Promise<InferSchemaOutput<TOutputSchema>>);
80
+ actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
25
81
  }
26
82
 
27
83
  declare function getRouter<T extends Lazyable<AnyRouter | undefined>>(router: T, path: readonly string[]): T extends Lazy<any> ? Lazy<AnyRouter | undefined> : Lazyable<AnyRouter | undefined>;
@@ -58,75 +114,379 @@ type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
58
114
  declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
59
115
 
60
116
  interface BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
117
+ /**
118
+ * This property holds the defined options.
119
+ */
61
120
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
121
+ /**
122
+ * Adds type-safe custom errors.
123
+ * The provided errors are spared-merged with any existing errors.
124
+ *
125
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
126
+ */
62
127
  'errors'<U extends ErrorMap>(errors: U): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
63
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & BuilderWithMiddlewares<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
128
+ /**
129
+ * Uses a middleware to modify the context or improve the pipeline.
130
+ *
131
+ * @info Supports both normal middleware and inline middleware implementations.
132
+ * @note The current context must be satisfy middleware dependent-context
133
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
134
+ */
135
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
136
+ /**
137
+ * Sets or updates the metadata.
138
+ * The provided metadata is spared-merged with any existing metadata.
139
+ *
140
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
141
+ */
64
142
  'meta'(meta: TMeta): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
143
+ /**
144
+ * Sets or updates the route definition.
145
+ * The provided route is spared-merged with any existing route.
146
+ * This option is typically relevant when integrating with OpenAPI.
147
+ *
148
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
149
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
150
+ */
65
151
  'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
152
+ /**
153
+ * Defines the input validation schema.
154
+ *
155
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
156
+ */
66
157
  'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
158
+ /**
159
+ * Defines the output validation schema.
160
+ *
161
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
162
+ */
67
163
  'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
164
+ /**
165
+ * Defines the handler of the procedure.
166
+ *
167
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
168
+ */
68
169
  'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
170
+ /**
171
+ * Prefixes all procedures in the router.
172
+ * The provided prefix is post-appended to any existing router prefix.
173
+ *
174
+ * @note This option does not affect procedures that do not define a path in their route definition.
175
+ *
176
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
177
+ */
69
178
  'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
179
+ /**
180
+ * Adds tags to all procedures in the router.
181
+ * This helpful when you want to group procedures together in the OpenAPI specification.
182
+ *
183
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
184
+ */
70
185
  'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
186
+ /**
187
+ * Applies all of the previously defined options to the specified router.
188
+ *
189
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
190
+ */
71
191
  'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
192
+ /**
193
+ * Create a lazy router
194
+ * And applies all of the previously defined options to the specified router.
195
+ *
196
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
197
+ */
72
198
  'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
73
199
  default: U;
74
200
  }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
75
201
  }
76
202
  interface ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
203
+ /**
204
+ * This property holds the defined options.
205
+ */
77
206
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
207
+ /**
208
+ * Adds type-safe custom errors.
209
+ * The provided errors are spared-merged with any existing errors.
210
+ *
211
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
212
+ */
78
213
  'errors'<U extends ErrorMap>(errors: U): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
79
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilder<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
214
+ /**
215
+ * Uses a middleware to modify the context or improve the pipeline.
216
+ *
217
+ * @info Supports both normal middleware and inline middleware implementations.
218
+ * @note The current context must be satisfy middleware dependent-context
219
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
220
+ */
221
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureBuilder<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
222
+ /**
223
+ * Sets or updates the metadata.
224
+ * The provided metadata is spared-merged with any existing metadata.
225
+ *
226
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
227
+ */
80
228
  'meta'(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
229
+ /**
230
+ * Sets or updates the route definition.
231
+ * The provided route is spared-merged with any existing route.
232
+ * This option is typically relevant when integrating with OpenAPI.
233
+ *
234
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
235
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
236
+ */
81
237
  'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
238
+ /**
239
+ * Defines the input validation schema.
240
+ *
241
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
242
+ */
82
243
  'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
244
+ /**
245
+ * Defines the output validation schema.
246
+ *
247
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
248
+ */
83
249
  'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
250
+ /**
251
+ * Defines the handler of the procedure.
252
+ *
253
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
254
+ */
84
255
  'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
85
256
  }
86
257
  interface ProcedureBuilderWithInput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
258
+ /**
259
+ * This property holds the defined options.
260
+ */
87
261
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
262
+ /**
263
+ * Adds type-safe custom errors.
264
+ * The provided errors are spared-merged with any existing errors.
265
+ *
266
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
267
+ */
88
268
  'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
89
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, InferSchemaOutput<TInputSchema>, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilderWithInput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
90
- 'use'<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilderWithInput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
269
+ /**
270
+ * Uses a middleware to modify the context or improve the pipeline.
271
+ *
272
+ * @info Supports both normal middleware and inline middleware implementations.
273
+ * @info Pass second argument to map the input.
274
+ * @note The current context must be satisfy middleware dependent-context
275
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
276
+ */
277
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferSchemaOutput<TInputSchema>, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureBuilderWithInput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
278
+ /**
279
+ * Uses a middleware to modify the context or improve the pipeline.
280
+ *
281
+ * @info Supports both normal middleware and inline middleware implementations.
282
+ * @info Pass second argument to map the input.
283
+ * @note The current context must be satisfy middleware dependent-context
284
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
285
+ */
286
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ProcedureBuilderWithInput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
287
+ /**
288
+ * Sets or updates the metadata.
289
+ * The provided metadata is spared-merged with any existing metadata.
290
+ *
291
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
292
+ */
91
293
  'meta'(meta: TMeta): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
294
+ /**
295
+ * Sets or updates the route definition.
296
+ * The provided route is spared-merged with any existing route.
297
+ * This option is typically relevant when integrating with OpenAPI.
298
+ *
299
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
300
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
301
+ */
92
302
  'route'(route: Route): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
303
+ /**
304
+ * Defines the output validation schema.
305
+ *
306
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
307
+ */
93
308
  'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
309
+ /**
310
+ * Defines the handler of the procedure.
311
+ *
312
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
313
+ */
94
314
  'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
95
315
  }
96
316
  interface ProcedureBuilderWithOutput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
317
+ /**
318
+ * This property holds the defined options.
319
+ */
97
320
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
321
+ /**
322
+ * Adds type-safe custom errors.
323
+ * The provided errors are spared-merged with any existing errors.
324
+ *
325
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
326
+ */
98
327
  'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
99
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilderWithOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
328
+ /**
329
+ * Uses a middleware to modify the context or improve the pipeline.
330
+ *
331
+ * @info Supports both normal middleware and inline middleware implementations.
332
+ * @note The current context must be satisfy middleware dependent-context
333
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
334
+ */
335
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureBuilderWithOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
336
+ /**
337
+ * Sets or updates the metadata.
338
+ * The provided metadata is spared-merged with any existing metadata.
339
+ *
340
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
341
+ */
100
342
  'meta'(meta: TMeta): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
343
+ /**
344
+ * Sets or updates the route definition.
345
+ * The provided route is spared-merged with any existing route.
346
+ * This option is typically relevant when integrating with OpenAPI.
347
+ *
348
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
349
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
350
+ */
101
351
  'route'(route: Route): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
352
+ /**
353
+ * Defines the input validation schema.
354
+ *
355
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
356
+ */
102
357
  'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
358
+ /**
359
+ * Defines the handler of the procedure.
360
+ *
361
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
362
+ */
103
363
  'handler'(handler: ProcedureHandler<TCurrentContext, unknown, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
104
364
  }
105
365
  interface ProcedureBuilderWithInputOutput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
366
+ /**
367
+ * This property holds the defined options.
368
+ */
106
369
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
370
+ /**
371
+ * Adds type-safe custom errors.
372
+ * The provided errors are spared-merged with any existing errors.
373
+ *
374
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
375
+ */
107
376
  'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
108
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilderWithInputOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
109
- 'use'<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureBuilderWithInputOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
377
+ /**
378
+ * Uses a middleware to modify the context or improve the pipeline.
379
+ *
380
+ * @info Supports both normal middleware and inline middleware implementations.
381
+ * @info Pass second argument to map the input.
382
+ * @note The current context must be satisfy middleware dependent-context
383
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
384
+ */
385
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureBuilderWithInputOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
386
+ /**
387
+ * Uses a middleware to modify the context or improve the pipeline.
388
+ *
389
+ * @info Supports both normal middleware and inline middleware implementations.
390
+ * @info Pass second argument to map the input.
391
+ * @note The current context must be satisfy middleware dependent-context
392
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
393
+ */
394
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ProcedureBuilderWithInputOutput<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
395
+ /**
396
+ * Sets or updates the metadata.
397
+ * The provided metadata is spared-merged with any existing metadata.
398
+ *
399
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
400
+ */
110
401
  'meta'(meta: TMeta): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
402
+ /**
403
+ * Sets or updates the route definition.
404
+ * The provided route is spared-merged with any existing route.
405
+ * This option is typically relevant when integrating with OpenAPI.
406
+ *
407
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
408
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
409
+ */
111
410
  'route'(route: Route): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
411
+ /**
412
+ * Defines the handler of the procedure.
413
+ *
414
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
415
+ */
112
416
  'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
113
417
  }
114
418
  interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
419
+ /**
420
+ * This property holds the defined options.
421
+ */
115
422
  '~orpc': EnhanceRouterOptions<TErrorMap>;
423
+ /**
424
+ * Adds type-safe custom errors.
425
+ * The provided errors are spared-merged with any existing errors.
426
+ *
427
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
428
+ */
116
429
  'errors'<U extends ErrorMap>(errors: U): RouterBuilder<TInitialContext, TCurrentContext, MergedErrorMap<TErrorMap, U>, TMeta>;
117
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & RouterBuilder<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TErrorMap, TMeta>;
430
+ /**
431
+ * Uses a middleware to modify the context or improve the pipeline.
432
+ *
433
+ * @info Supports both normal middleware and inline middleware implementations.
434
+ * @note The current context must be satisfy middleware dependent-context
435
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
436
+ */
437
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): RouterBuilder<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TErrorMap, TMeta>;
438
+ /**
439
+ * Prefixes all procedures in the router.
440
+ * The provided prefix is post-appended to any existing router prefix.
441
+ *
442
+ * @note This option does not affect procedures that do not define a path in their route definition.
443
+ *
444
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
445
+ */
118
446
  'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
447
+ /**
448
+ * Adds tags to all procedures in the router.
449
+ * This helpful when you want to group procedures together in the OpenAPI specification.
450
+ *
451
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
452
+ */
119
453
  'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
454
+ /**
455
+ * Applies all of the previously defined options to the specified router.
456
+ *
457
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
458
+ */
120
459
  'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
460
+ /**
461
+ * Create a lazy router
462
+ * And applies all of the previously defined options to the specified router.
463
+ *
464
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
465
+ */
121
466
  'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
122
467
  default: U;
123
468
  }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
124
469
  }
125
470
 
126
471
  interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> extends Middleware<TInContext, TOutContext, TInput, TOutput, TErrorConstructorMap, TMeta> {
472
+ /**
473
+ * Change the expected input type by providing a map function.
474
+ */
127
475
  mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput, TErrorConstructorMap, TMeta>;
128
- concat<UOutContext extends Context, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext, UOutContext, TInput, TOutput, TErrorConstructorMap, TMeta>): ContextExtendsGuard<MergedCurrentContext<TInContext, TOutContext>, UInContext> & DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, TInput, TOutput, TErrorConstructorMap, TMeta>;
129
- concat<UOutContext extends Context, UMappedInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext, UOutContext, UMappedInput, TOutput, TErrorConstructorMap, TMeta>, mapInput: MapInputMiddleware<TInput, UMappedInput>): ContextExtendsGuard<MergedCurrentContext<TInContext, TOutContext>, UInContext> & DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, TInput, TOutput, TErrorConstructorMap, TMeta>;
476
+ /**
477
+ * Concatenates two middlewares.
478
+ *
479
+ * @info Pass second argument to map the input.
480
+ * @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
481
+ */
482
+ concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UInput extends TInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, UInput, TOutput, TErrorConstructorMap, TMeta>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TErrorConstructorMap, TMeta>;
483
+ /**
484
+ * Concatenates two middlewares.
485
+ *
486
+ * @info Pass second argument to map the input.
487
+ * @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
488
+ */
489
+ concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UInput extends TInput, UMappedInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, UMappedInput, TOutput, TErrorConstructorMap, TMeta>, mapInput: MapInputMiddleware<UInput, UMappedInput>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TErrorConstructorMap, TMeta>;
130
490
  }
131
491
  declare function decorateMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta>(middleware: Middleware<TInContext, TOutContext, TInput, TOutput, TErrorConstructorMap, TMeta>): DecoratedMiddleware<TInContext, TOutContext, TInput, TOutput, TErrorConstructorMap, TMeta>;
132
492
 
@@ -142,38 +502,128 @@ interface BuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySc
142
502
  config: BuilderConfig;
143
503
  }
144
504
  declare class Builder<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
505
+ /**
506
+ * This property holds the defined options.
507
+ */
145
508
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
146
509
  constructor(def: BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
147
510
  /**
148
- * Reset config
511
+ * Sets or overrides the config.
512
+ *
513
+ * @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
514
+ * @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
149
515
  */
150
516
  $config(config: BuilderConfig): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
151
517
  /**
152
- * Reset initial context
518
+ * Set or override the initial context.
519
+ *
520
+ * @see {@link https://orpc.unnoq.com/docs/context Context Docs}
153
521
  */
154
- $context<U extends Context>(): Builder<U, U, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
522
+ $context<U extends Context>(): Builder<U & Record<never, never>, U, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
155
523
  /**
156
- * Reset initial meta
524
+ * Sets or overrides the initial meta.
525
+ *
526
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
157
527
  */
158
- $meta<U extends Meta>(initialMeta: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, U>;
528
+ $meta<U extends Meta>(initialMeta: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
159
529
  /**
160
- * Reset initial route
530
+ * Sets or overrides the initial route.
531
+ * This option is typically relevant when integrating with OpenAPI.
532
+ *
533
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
534
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
161
535
  */
162
536
  $route(initialRoute: Route): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
537
+ /**
538
+ * Sets or overrides the initial input schema.
539
+ *
540
+ * @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
541
+ */
163
542
  $input<U extends AnySchema>(initialInputSchema?: U): Builder<TInitialContext, TCurrentContext, U, TOutputSchema, TErrorMap, TMeta>;
164
- middleware<UOutContext extends Context, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
165
- middleware: Middleware<TCurrentContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>, TMeta>): DecoratedMiddleware<TCurrentContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<any>, TMeta>;
543
+ /**
544
+ * Creates a middleware.
545
+ *
546
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
547
+ */
548
+ middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
549
+ middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>, TMeta>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, TMeta>;
550
+ /**
551
+ * Adds type-safe custom errors.
552
+ * The provided errors are spared-merged with any existing errors.
553
+ *
554
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
555
+ */
166
556
  errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
167
- use<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & BuilderWithMiddlewares<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
168
- use<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<unknown, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & BuilderWithMiddlewares<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
557
+ /**
558
+ * Uses a middleware to modify the context or improve the pipeline.
559
+ *
560
+ * @info Supports both normal middleware and inline middleware implementations.
561
+ * @note The current context must be satisfy middleware dependent-context
562
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
563
+ */
564
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<TErrorMap>, TMeta>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
565
+ /**
566
+ * Sets or updates the metadata.
567
+ * The provided metadata is spared-merged with any existing metadata.
568
+ *
569
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
570
+ */
169
571
  meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
572
+ /**
573
+ * Sets or updates the route definition.
574
+ * The provided route is spared-merged with any existing route.
575
+ * This option is typically relevant when integrating with OpenAPI.
576
+ *
577
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
578
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
579
+ */
170
580
  route(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
581
+ /**
582
+ * Defines the input validation schema.
583
+ *
584
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
585
+ */
171
586
  input<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
587
+ /**
588
+ * Defines the output validation schema.
589
+ *
590
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
591
+ */
172
592
  output<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
593
+ /**
594
+ * Defines the handler of the procedure.
595
+ *
596
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
597
+ */
173
598
  handler<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
599
+ /**
600
+ * Prefixes all procedures in the router.
601
+ * The provided prefix is post-appended to any existing router prefix.
602
+ *
603
+ * @note This option does not affect procedures that do not define a path in their route definition.
604
+ *
605
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
606
+ */
174
607
  prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
608
+ /**
609
+ * Adds tags to all procedures in the router.
610
+ * This helpful when you want to group procedures together in the OpenAPI specification.
611
+ *
612
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
613
+ */
175
614
  tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
615
+ /**
616
+ * Applies all of the previously defined options to the specified router.
617
+ *
618
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
619
+ */
176
620
  router<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
621
+ /**
622
+ * Create a lazy router
623
+ * And applies all of the previously defined options to the specified router.
624
+ *
625
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
626
+ */
177
627
  lazy<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
178
628
  default: U;
179
629
  }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
@@ -191,30 +641,91 @@ declare function fallbackConfig<T extends keyof Config>(key: T, value?: Config[T
191
641
  * Like `DecoratedProcedure`, but removed all method that can change the contract.
192
642
  */
193
643
  interface ImplementedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> {
194
- use<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ContextExtendsGuard<MergedCurrentContext<TCurrentContext, UOutContext>, TCurrentContext> & ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
195
- use<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & ContextExtendsGuard<MergedCurrentContext<TCurrentContext, UOutContext>, TCurrentContext> & ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
644
+ /**
645
+ * Uses a middleware to modify the context or improve the pipeline.
646
+ *
647
+ * @info Supports both normal middleware and inline middleware implementations.
648
+ * @info Pass second argument to map the input.
649
+ * @note The current context must be satisfy middleware dependent-context
650
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
651
+ */
652
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
653
+ /**
654
+ * Uses a middleware to modify the context or improve the pipeline.
655
+ *
656
+ * @info Supports both normal middleware and inline middleware implementations.
657
+ * @info Pass second argument to map the input.
658
+ * @note The current context must be satisfy middleware dependent-context
659
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
660
+ */
661
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
196
662
  /**
197
663
  * Make this procedure callable (works like a function while still being a procedure).
664
+ *
665
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
198
666
  */
199
- callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
667
+ callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
200
668
  /**
201
- * Make this procedure compatible with server action (the same as .callable, but the type is compatible with server action).
669
+ * Make this procedure compatible with server action.
670
+ *
671
+ * @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
202
672
  */
203
- actionable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ((...rest: ClientRest<TClientContext, InferSchemaInput<TInputSchema>>) => Promise<InferSchemaOutput<TOutputSchema>>);
673
+ actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
204
674
  }
205
675
  /**
206
676
  * Like `ProcedureBuilderWithoutHandler`, but removed all method that can change the contract.
207
677
  */
208
678
  interface ProcedureImplementer<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
209
679
  '~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
210
- 'use'<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
211
- 'use'<UOutContext extends Context, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ContextExtendsGuard<TCurrentContext, UInContext> & ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
680
+ /**
681
+ * Uses a middleware to modify the context or improve the pipeline.
682
+ *
683
+ * @info Supports both normal middleware and inline middleware implementations.
684
+ * @info Pass second argument to map the input.
685
+ * @note The current context must be satisfy middleware dependent-context
686
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
687
+ */
688
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
689
+ /**
690
+ * Uses a middleware to modify the context or improve the pipeline.
691
+ *
692
+ * @info Supports both normal middleware and inline middleware implementations.
693
+ * @info Pass second argument to map the input.
694
+ * @note The current context must be satisfy middleware dependent-context
695
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
696
+ */
697
+ 'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferSchemaOutput<TInputSchema>, UInput>): ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
698
+ /**
699
+ * Defines the handler of the procedure.
700
+ *
701
+ * @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
702
+ */
212
703
  'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
213
704
  }
214
705
 
215
706
  interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
216
- use<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): ContextExtendsGuard<TCurrentContext, UInContext> & ImplementerInternalWithMiddlewares<T, MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>>;
707
+ /**
708
+ * Uses a middleware to modify the context or improve the pipeline.
709
+ *
710
+ * @info Supports both normal middleware and inline middleware implementations.
711
+ * @note The current context must be satisfy middleware dependent-context
712
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
713
+ */
714
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): ImplementerInternalWithMiddlewares<T, MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>>;
715
+ /**
716
+ * Applies all of the previously defined options to the specified router.
717
+ * And enforces the router match the contract.
718
+ *
719
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
720
+ */
217
721
  router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
722
+ /**
723
+ * Create a lazy router
724
+ * And applies all of the previously defined options to the specified router.
725
+ * And enforces the router match the contract.
726
+ *
727
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
728
+ */
218
729
  lazy<U extends Router<T, TInitialContext>>(loader: () => Promise<{
219
730
  default: U;
220
731
  }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
@@ -224,10 +735,35 @@ type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TIn
224
735
  });
225
736
 
226
737
  interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
227
- middleware<UOutContext extends Context, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
228
- middleware: Middleware<TCurrentContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): DecoratedMiddleware<TCurrentContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<any>, InferContractRouterMeta<T>>;
229
- use<UOutContext extends Context, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): ContextExtendsGuard<TCurrentContext, UInContext> & ImplementerInternalWithMiddlewares<T, MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>>;
738
+ /**
739
+ * Creates a middleware.
740
+ *
741
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
742
+ */
743
+ middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
744
+ middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, InferContractRouterMeta<T>>;
745
+ /**
746
+ * Uses a middleware to modify the context or improve the pipeline.
747
+ *
748
+ * @info Supports both normal middleware and inline middleware implementations.
749
+ * @note The current context must be satisfy middleware dependent-context
750
+ * @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
751
+ */
752
+ use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): ImplementerInternalWithMiddlewares<T, MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>>;
753
+ /**
754
+ * Applies all of the previously defined options to the specified router.
755
+ * And enforces the router match the contract.
756
+ *
757
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
758
+ */
230
759
  router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
760
+ /**
761
+ * Create a lazy router
762
+ * And applies all of the previously defined options to the specified router.
763
+ * And enforces the router match the contract.
764
+ *
765
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
766
+ */
231
767
  lazy<U extends Router<T, TCurrentContext>>(loader: () => Promise<{
232
768
  default: U;
233
769
  }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
@@ -237,10 +773,21 @@ type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext ex
237
773
  });
238
774
  declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, config: BuilderConfig, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
239
775
  type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
240
- $context<U extends Context>(): Implementer<TContract, U, U>;
776
+ /**
777
+ * Set or override the initial context.
778
+ *
779
+ * @see {@link https://orpc.unnoq.com/docs/context Context Docs}
780
+ */
781
+ $context<U extends Context>(): Implementer<TContract, U & Record<never, never>, U>;
782
+ /**
783
+ * Sets or overrides the config.
784
+ *
785
+ * @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
786
+ * @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
787
+ */
241
788
  $config(config: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
242
789
  } & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
243
- declare function implement<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: TContract, config?: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
790
+ declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
244
791
 
245
792
  declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
246
793
  declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
@@ -263,16 +810,20 @@ declare function createContractedProcedure(procedure: AnyProcedure, contract: An
263
810
  * ```
264
811
  *
265
812
  */
266
- declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
813
+ declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
267
814
 
268
815
  type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
269
816
  [K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
270
817
  };
271
- declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...[options]: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): RouterClient<T, TClientContext>;
818
+ /**
819
+ * Create Server-side client from a router.
820
+ *
821
+ * @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
822
+ */
823
+ declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): RouterClient<T, TClientContext>;
272
824
 
273
825
  declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
274
826
  declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
275
827
 
276
- declare function toHttpPath(path: readonly string[]): HTTPPath;
277
-
278
- export { type AccessibleLazyRouter, AnyMiddleware, AnyProcedure, AnyRouter, Builder, type BuilderConfig, type BuilderDef, type BuilderWithMiddlewares, type Config, Context, ContextExtendsGuard, type ContractProcedureCallbackOptions, CreateProcedureClientOptions, type DecoratedMiddleware, DecoratedProcedure, type EnhanceRouterOptions, type EnhancedRouter, type ImplementedProcedure, type Implementer, type ImplementerInternal, type ImplementerInternalWithMiddlewares, InferRouterInitialContext, Lazy, type LazyTraverseContractProceduresOptions, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, type ProcedureBuilder, type ProcedureBuilderWithInput, type ProcedureBuilderWithInputOutput, type ProcedureBuilderWithOutput, ProcedureClient, ProcedureHandler, type ProcedureImplementer, Router, type RouterBuilder, type RouterClient, type RouterImplementer, type RouterImplementerWithMiddlewares, type TraverseContractProceduresOptions, type UnlaziedRouter, addMiddleware, call, createAccessibleLazyRouter, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, toHttpPath, traverseContractProcedures, unlazyRouter };
828
+ export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
829
+ export type { AccessibleLazyRouter, ActionableClient, ActionableClientRest, ActionableClientResult, ActionableError, BuilderConfig, BuilderDef, BuilderWithMiddlewares, Config, ContractProcedureCallbackOptions, DecoratedMiddleware, EnhanceRouterOptions, EnhancedRouter, ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, LazyTraverseContractProceduresOptions, ProcedureActionableClient, ProcedureBuilder, ProcedureBuilderWithInput, ProcedureBuilderWithInputOutput, ProcedureBuilderWithOutput, ProcedureImplementer, RouterBuilder, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, TraverseContractProceduresOptions, UnactionableError, UnlaziedRouter };