@orpc/server 1.0.0-beta.7 → 1.0.3
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.
- package/README.md +13 -17
- package/dist/adapters/fetch/index.d.mts +15 -4
- package/dist/adapters/fetch/index.d.ts +15 -4
- package/dist/adapters/fetch/index.mjs +2 -2
- package/dist/adapters/node/index.d.mts +15 -4
- package/dist/adapters/node/index.d.ts +15 -4
- package/dist/adapters/node/index.mjs +2 -2
- package/dist/adapters/standard/index.d.mts +4 -4
- package/dist/adapters/standard/index.d.ts +4 -4
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/index.d.mts +543 -6
- package/dist/index.d.ts +543 -6
- package/dist/index.mjs +114 -6
- package/dist/plugins/index.d.mts +33 -2
- package/dist/plugins/index.d.ts +33 -2
- package/dist/shared/{server.BuLPHTX1.d.mts → server.CN0534_m.d.mts} +2 -2
- package/dist/shared/{server.DMhSfHk1.d.ts → server.CjlA3NKP.d.ts} +2 -2
- package/dist/shared/{server.D_vpYits.d.ts → server.CuD15qZB.d.ts} +2 -2
- package/dist/shared/{server.CaWivVk3.d.ts → server.D5fBlF9j.d.ts} +1 -1
- package/dist/shared/{server.C37gDhSZ.mjs → server.DG7Tamti.mjs} +3 -0
- package/dist/shared/{server.BVHsfJ99.d.mts → server.DPWk5pjW.d.mts} +51 -3
- package/dist/shared/{server.BVHsfJ99.d.ts → server.DPWk5pjW.d.ts} +51 -3
- package/dist/shared/{server.B1oIHH_j.d.mts → server.DY7OKEoj.d.mts} +1 -1
- package/dist/shared/{server.Dwnm6cSk.d.mts → server.DjgtLwKi.d.mts} +2 -2
- package/dist/shared/{server.DFuJLDuo.mjs → server.qf03T-Xn.mjs} +1 -1
- package/package.json +7 -7
package/dist/index.d.mts
CHANGED
@@ -4,8 +4,8 @@ import { AnySchema, ErrorMap, InferSchemaInput, InferSchemaOutput, ErrorFromErro
|
|
4
4
|
export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type } from '@orpc/contract';
|
5
5
|
import { ThrowableError, IntersectPick, MaybeOptionalOptions } from '@orpc/shared';
|
6
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.
|
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.
|
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.mjs';
|
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.mjs';
|
9
9
|
export { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
10
10
|
|
11
11
|
type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
|
@@ -25,17 +25,57 @@ type ProcedureActionableClient<TInputSchema extends AnySchema, TOutputSchema ext
|
|
25
25
|
declare function createActionableClient<TInput, TOutput, TError>(client: Client<Record<never, never>, TInput, TOutput, TError>): ActionableClient<TInput, TOutput, ActionableError<TError>>;
|
26
26
|
|
27
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
|
+
*/
|
28
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
|
+
*/
|
29
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
|
+
*/
|
30
50
|
route(route: Route): DecoratedProcedure<TInitialContext, TCurrentContext, 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
|
+
*/
|
31
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
|
+
*/
|
32
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>;
|
33
69
|
/**
|
34
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}
|
35
73
|
*/
|
36
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>;
|
37
75
|
/**
|
38
76
|
* Make this procedure compatible with server action.
|
77
|
+
*
|
78
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
39
79
|
*/
|
40
80
|
actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
|
41
81
|
}
|
@@ -74,74 +114,378 @@ type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
|
|
74
114
|
declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
|
75
115
|
|
76
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
|
+
*/
|
77
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
|
+
*/
|
78
127
|
'errors'<U extends ErrorMap>(errors: U): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
79
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
|
+
*/
|
80
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
|
+
*/
|
81
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
|
+
*/
|
82
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
|
+
*/
|
83
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
|
+
*/
|
84
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
|
+
*/
|
85
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
|
+
*/
|
86
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
|
+
*/
|
87
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
|
+
*/
|
88
198
|
'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
89
199
|
default: U;
|
90
200
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
91
201
|
}
|
92
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
|
+
*/
|
93
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
|
+
*/
|
94
213
|
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
95
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
|
+
*/
|
96
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
|
+
*/
|
97
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
|
+
*/
|
98
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
|
+
*/
|
99
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
|
+
*/
|
100
255
|
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
101
256
|
}
|
102
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
|
+
*/
|
103
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
|
+
*/
|
104
268
|
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
105
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
|
+
*/
|
106
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
|
+
*/
|
107
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
|
+
*/
|
108
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
|
+
*/
|
109
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
|
+
*/
|
110
314
|
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
111
315
|
}
|
112
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
|
+
*/
|
113
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
|
+
*/
|
114
327
|
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
115
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
|
+
*/
|
116
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
|
+
*/
|
117
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
|
+
*/
|
118
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
|
+
*/
|
119
363
|
'handler'(handler: ProcedureHandler<TCurrentContext, unknown, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
120
364
|
}
|
121
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
|
+
*/
|
122
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
|
+
*/
|
123
376
|
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
124
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
|
+
*/
|
125
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
|
+
*/
|
126
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
|
+
*/
|
127
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
|
+
*/
|
128
416
|
'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
129
417
|
}
|
130
418
|
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
419
|
+
/**
|
420
|
+
* This property holds the defined options.
|
421
|
+
*/
|
131
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
|
+
*/
|
132
429
|
'errors'<U extends ErrorMap>(errors: U): RouterBuilder<TInitialContext, TCurrentContext, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
133
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
|
+
*/
|
134
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
|
+
*/
|
135
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
|
+
*/
|
136
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
|
+
*/
|
137
466
|
'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
138
467
|
default: U;
|
139
468
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
140
469
|
}
|
141
470
|
|
142
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
|
+
*/
|
143
475
|
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, 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
|
+
*/
|
144
482
|
concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, TInput, TOutput, TErrorConstructorMap, TMeta>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, TInput, 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
|
+
*/
|
145
489
|
concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UMappedInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, UMappedInput, TOutput, TErrorConstructorMap, TMeta>, mapInput: MapInputMiddleware<TInput, UMappedInput>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, TInput, TOutput, TErrorConstructorMap, TMeta>;
|
146
490
|
}
|
147
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>;
|
@@ -158,37 +502,128 @@ interface BuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySc
|
|
158
502
|
config: BuilderConfig;
|
159
503
|
}
|
160
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
|
+
*/
|
161
508
|
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
162
509
|
constructor(def: BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
163
510
|
/**
|
164
|
-
*
|
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}
|
165
515
|
*/
|
166
516
|
$config(config: BuilderConfig): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
167
517
|
/**
|
168
|
-
*
|
518
|
+
* Set or override the initial context.
|
519
|
+
*
|
520
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
169
521
|
*/
|
170
522
|
$context<U extends Context>(): Builder<U & Record<never, never>, U, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
171
523
|
/**
|
172
|
-
*
|
524
|
+
* Sets or overrides the initial meta.
|
525
|
+
*
|
526
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
173
527
|
*/
|
174
528
|
$meta<U extends Meta>(initialMeta: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
|
175
529
|
/**
|
176
|
-
*
|
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}
|
177
535
|
*/
|
178
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
|
+
*/
|
179
542
|
$input<U extends AnySchema>(initialInputSchema?: U): Builder<TInitialContext, TCurrentContext, U, TOutputSchema, TErrorMap, TMeta>;
|
543
|
+
/**
|
544
|
+
* Creates a middleware.
|
545
|
+
*
|
546
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
547
|
+
*/
|
180
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
|
181
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
|
+
*/
|
182
556
|
errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, 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
|
+
*/
|
183
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
|
+
*/
|
184
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
|
+
*/
|
185
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
|
+
*/
|
186
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
|
+
*/
|
187
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
|
+
*/
|
188
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
|
+
*/
|
189
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
|
+
*/
|
190
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
|
+
*/
|
191
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
|
+
*/
|
192
627
|
lazy<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
193
628
|
default: U;
|
194
629
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
@@ -206,14 +641,34 @@ declare function fallbackConfig<T extends keyof Config>(key: T, value?: Config[T
|
|
206
641
|
* Like `DecoratedProcedure`, but removed all method that can change the contract.
|
207
642
|
*/
|
208
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> {
|
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
|
+
*/
|
209
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
|
+
*/
|
210
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>;
|
211
662
|
/**
|
212
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}
|
213
666
|
*/
|
214
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>;
|
215
668
|
/**
|
216
669
|
* Make this procedure compatible with server action.
|
670
|
+
*
|
671
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
217
672
|
*/
|
218
673
|
actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
|
219
674
|
}
|
@@ -222,14 +677,55 @@ interface ImplementedProcedure<TInitialContext extends Context, TCurrentContext
|
|
222
677
|
*/
|
223
678
|
interface ProcedureImplementer<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
224
679
|
'~orpc': BuilderDef<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
|
+
*/
|
225
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
|
+
*/
|
226
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
|
+
*/
|
227
703
|
'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
228
704
|
}
|
229
705
|
|
230
706
|
interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
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
|
+
*/
|
231
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
|
+
*/
|
232
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
|
+
*/
|
233
729
|
lazy<U extends Router<T, TInitialContext>>(loader: () => Promise<{
|
234
730
|
default: U;
|
235
731
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
@@ -239,10 +735,35 @@ type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TIn
|
|
239
735
|
});
|
240
736
|
|
241
737
|
interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
738
|
+
/**
|
739
|
+
* Creates a middleware.
|
740
|
+
*
|
741
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
742
|
+
*/
|
242
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
|
243
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
|
+
*/
|
244
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
|
+
*/
|
245
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
|
+
*/
|
246
767
|
lazy<U extends Router<T, TCurrentContext>>(loader: () => Promise<{
|
247
768
|
default: U;
|
248
769
|
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
@@ -252,7 +773,18 @@ type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext ex
|
|
252
773
|
});
|
253
774
|
declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, config: BuilderConfig, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
|
254
775
|
type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
|
776
|
+
/**
|
777
|
+
* Set or override the initial context.
|
778
|
+
*
|
779
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
780
|
+
*/
|
255
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
|
+
*/
|
256
788
|
$config(config: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
|
257
789
|
} & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
|
258
790
|
declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
|
@@ -283,6 +815,11 @@ declare function call<TInitialContext extends Context, TInputSchema extends AnyS
|
|
283
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> : {
|
284
816
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
285
817
|
};
|
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
|
+
*/
|
286
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>;
|
287
824
|
|
288
825
|
declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
|