@orpc/server 1.14.5 → 2.0.0-beta.1
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 +75 -136
- package/dist/adapters/crossws/index.d.mts +42 -21
- package/dist/adapters/crossws/index.d.ts +42 -21
- package/dist/adapters/crossws/index.mjs +37 -18
- package/dist/adapters/fetch/index.d.mts +83 -67
- package/dist/adapters/fetch/index.d.ts +83 -67
- package/dist/adapters/fetch/index.mjs +131 -106
- package/dist/adapters/message-port/index.d.mts +51 -34
- package/dist/adapters/message-port/index.d.ts +51 -34
- package/dist/adapters/message-port/index.mjs +73 -38
- package/dist/adapters/node/index.d.mts +82 -60
- package/dist/adapters/node/index.d.ts +82 -60
- package/dist/adapters/node/index.mjs +127 -98
- package/dist/adapters/standard/index.d.mts +16 -18
- package/dist/adapters/standard/index.d.ts +16 -18
- package/dist/adapters/standard/index.mjs +5 -5
- package/dist/adapters/standard-peer/index.d.mts +12 -14
- package/dist/adapters/standard-peer/index.d.ts +12 -14
- package/dist/adapters/standard-peer/index.mjs +2 -21
- package/dist/adapters/websocket/index.d.mts +39 -34
- package/dist/adapters/websocket/index.d.ts +39 -34
- package/dist/adapters/websocket/index.mjs +42 -33
- package/dist/extensions/callable.d.mts +10 -0
- package/dist/extensions/callable.d.ts +10 -0
- package/dist/extensions/callable.mjs +11 -0
- package/dist/helpers/index.d.mts +2 -2
- package/dist/helpers/index.d.ts +2 -2
- package/dist/helpers/index.mjs +1 -1
- package/dist/index.d.mts +163 -770
- package/dist/index.d.ts +163 -770
- package/dist/index.mjs +296 -403
- package/dist/plugins/index.d.mts +105 -143
- package/dist/plugins/index.d.ts +105 -143
- package/dist/plugins/index.mjs +232 -255
- package/dist/shared/server.BB_Ik9Ph.d.mts +104 -0
- package/dist/shared/server.BL22TloH.d.mts +184 -0
- package/dist/shared/server.BL22TloH.d.ts +184 -0
- package/dist/shared/server.B_U9y00a.d.mts +66 -0
- package/dist/shared/server.BsNNjG5J.d.mts +61 -0
- package/dist/shared/server.BwHnWUuN.mjs +222 -0
- package/dist/shared/server.CX4vUnDk.mjs +11 -0
- package/dist/shared/server.CjOb6ItT.mjs +41 -0
- package/dist/shared/server.CrlKQucM.mjs +233 -0
- package/dist/shared/server.D_QauotT.mjs +30 -0
- package/dist/shared/server.EOHJ3NJr.d.ts +104 -0
- package/dist/shared/server.GDpX6Df8.mjs +271 -0
- package/dist/shared/server.Pa0F03f_.d.ts +61 -0
- package/dist/shared/server.T9F3bzZx.d.ts +66 -0
- package/dist/shared/{server.DZ5BIITo.mjs → server.W91HSRkE.mjs} +2 -2
- package/package.json +26 -55
- package/dist/adapters/aws-lambda/index.d.mts +0 -46
- package/dist/adapters/aws-lambda/index.d.ts +0 -46
- package/dist/adapters/aws-lambda/index.mjs +0 -40
- package/dist/adapters/bun-ws/index.d.mts +0 -36
- package/dist/adapters/bun-ws/index.d.ts +0 -36
- package/dist/adapters/bun-ws/index.mjs +0 -47
- package/dist/adapters/fastify/index.d.mts +0 -53
- package/dist/adapters/fastify/index.d.ts +0 -53
- package/dist/adapters/fastify/index.mjs +0 -52
- package/dist/adapters/ws/index.d.mts +0 -31
- package/dist/adapters/ws/index.d.ts +0 -31
- package/dist/adapters/ws/index.mjs +0 -37
- package/dist/hibernation/index.d.mts +0 -44
- package/dist/hibernation/index.d.ts +0 -44
- package/dist/hibernation/index.mjs +0 -65
- package/dist/shared/server.7cEtMB30.d.ts +0 -74
- package/dist/shared/server.B8gYOD5g.d.mts +0 -12
- package/dist/shared/server.BqadksTP.d.mts +0 -74
- package/dist/shared/server.C8_sRzQB.d.mts +0 -42
- package/dist/shared/server.ChUyt5-i.d.mts +0 -32
- package/dist/shared/server.ChyoA9XY.d.ts +0 -42
- package/dist/shared/server.DEBcqOjg.mjs +0 -418
- package/dist/shared/server.EfTOZ2Q7.d.ts +0 -12
- package/dist/shared/server.TEVCLCFC.mjs +0 -39
- package/dist/shared/server.ZxHCEN1h.mjs +0 -226
- package/dist/shared/server.qKsRrdxW.d.mts +0 -193
- package/dist/shared/server.qKsRrdxW.d.ts +0 -193
- package/dist/shared/server.yoEB3Fx4.d.ts +0 -32
package/dist/index.d.mts
CHANGED
|
@@ -1,803 +1,196 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
3
|
-
import {
|
|
4
|
-
export {
|
|
5
|
-
import {
|
|
6
|
-
export {
|
|
7
|
-
import { C as Context,
|
|
8
|
-
export {
|
|
9
|
-
import {
|
|
10
|
-
export {
|
|
11
|
-
export { ErrorEvent,
|
|
1
|
+
import { AnyORPCError, ClientOptions, ClientContext } from '@orpc/client';
|
|
2
|
+
export { AnyORPCError, AnyORPCErrorJSON, COMMON_ERROR_STATUS_MAP, ORPCError, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, RPCJsonSerialization, RPCJsonSerializationMeta, RPCJsonSerializer, RPCJsonSerializerHandler, RPCJsonSerializerOptions, RPCSerializer, RPCSerializerOptions, RPCSerializerSerializeOptions, cloneORPCError, isDefinedError, isInferableError, safe, toORPCError } from '@orpc/client';
|
|
3
|
+
import { ErrorMap, MergedErrorMap, AnySchema, MetaPlugin, InferSchemaOutput, InferSchemaInput, AugmentContractRouterOptions, RouterContract, AnyProcedureContract, InitialInputSchema, InitialOutputSchema, MergedSchema, Schema, ProcedureContractDefinition, ProcedureContract, InferRouterContractErrorMap, ORPCErrorFromErrorMap } from '@orpc/contract';
|
|
4
|
+
export { AnyMetaPlugin, AnySchema, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, MergedErrorMap, Meta, MetaPlugin, MetaPluginDefinition, ORPCErrorFromErrorMap, ProcedureContract, ProcedureContractDefinition, RouterContract, Schema, ValidationError, defineMeta, eventIterator, reconcileORPCError, type } from '@orpc/contract';
|
|
5
|
+
import { IntersectPick, Promisable, Public, PromiseWithError, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
|
|
6
|
+
export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
7
|
+
import { C as Context, d as Middleware, M as MergedContext, e as MergedInitialContext, a as Procedure, f as AnyMiddleware, g as Lazy, A as AnyProcedure, L as Lazyable, h as ProcedureHandler, O as ORPCErrorConstructorMap, i as OrderedMiddleware, P as ProcedureClientOptions, b as ProcedureClient } from './shared/server.BL22TloH.mjs';
|
|
8
|
+
export { j as LazyDefinition, k as MiddlewareDefinition, l as MiddlewareDone, m as MiddlewareDoneOptions, n as MiddlewareNext, o as MiddlewareNextOptions, p as MiddlewareOptions, q as MiddlewareResult, r as ORPCErrorConstructorMapItem, s as ORPCErrorConstructorMapItemOptions, c as ProcedureClientInterceptor, t as ProcedureClientInterceptorOptions, u as ProcedureDefinition, v as ProcedureHandlerOptions, w as createORPCErrorConstructorMap, x as createProcedureClient, y as unlazy } from './shared/server.BL22TloH.mjs';
|
|
9
|
+
import { A as AnyRouter, R as Router, C as ContractedRouter, I as InferRouterInitialContext } from './shared/server.BsNNjG5J.mjs';
|
|
10
|
+
export { a as InferRouterError, b as InferRouterErrors, c as InferRouterFinalContexts, d as InferRouterInitialContexts, e as InferRouterInputs, f as InferRouterOutputs } from './shared/server.BsNNjG5J.mjs';
|
|
11
|
+
export { ErrorEvent, getEventMeta, unwrapEvent, withEventMeta } from '@standardserver/core';
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
};
|
|
18
|
-
type UnactionableError<T> = T extends {
|
|
19
|
-
defined: true;
|
|
20
|
-
} & ORPCErrorJSON<infer U, infer V> ? ORPCError<U, V> : ThrowableError;
|
|
21
|
-
type ActionableClientRest<TInput> = [input: TInput] | (undefined extends TInput ? [input?: TInput] : [input: TInput]);
|
|
22
|
-
type ActionableClientResult<TOutput, TError extends ORPCErrorJSON<any, any>> = [error: null, data: TOutput] | [error: TError, data: undefined];
|
|
23
|
-
interface ActionableClient<TInput, TOutput, TError extends ORPCErrorJSON<any, any>> {
|
|
24
|
-
(...rest: ActionableClientRest<TInput>): Promise<ActionableClientResult<TOutput, TError>>;
|
|
13
|
+
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorMap extends ErrorMap> extends Middleware<TInContext, TOutContext, TInput, TOutput, TErrorMap> {
|
|
14
|
+
adaptInput<T>(adapt: (input: T) => TInput): DecoratedMiddleware<TInContext, TOutContext, T, TOutput, TErrorMap>;
|
|
15
|
+
errors<T extends ErrorMap>(errors: T): DecoratedMiddleware<TInContext, TOutContext, TInput, TOutput, MergedErrorMap<TErrorMap, T>>;
|
|
16
|
+
use<$OutContext extends IntersectPick<MergedContext<TInContext, TOutContext>, $OutContext>, $Input extends TInput, $InContext extends Context = MergedContext<TInContext, TOutContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInContext, TOutContext>, $OutContext, $Input, TOutput, $ErrorMap>): DecoratedMiddleware<MergedInitialContext<TInContext, TOutContext, $InContext>, MergedContext<TOutContext, $OutContext>, $Input, TOutput, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
25
17
|
}
|
|
26
|
-
|
|
27
|
-
declare function createActionableClient<TInput, TOutput, TError>(client: Client<Record<never, never>, TInput, TOutput, TError>): ActionableClient<TInput, TOutput, ActionableError<TError>>;
|
|
18
|
+
declare function decorateMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorMap extends ErrorMap>(middleware: Middleware<TInContext, TOutContext, TInput, TOutput, TErrorMap>): DecoratedMiddleware<TInContext, TOutContext, TInput, TOutput, TErrorMap>;
|
|
28
19
|
|
|
29
|
-
declare class DecoratedProcedure<TInitialContext extends Context,
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
*
|
|
34
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
35
|
-
*/
|
|
36
|
-
errors<U extends ErrorMap>(errors: U): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
37
|
-
/**
|
|
38
|
-
* Sets or updates the metadata.
|
|
39
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
40
|
-
*
|
|
41
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
42
|
-
*/
|
|
43
|
-
meta(meta: TMeta): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
44
|
-
/**
|
|
45
|
-
* Sets or updates the route definition.
|
|
46
|
-
* The provided route is spared-merged with any existing route.
|
|
47
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
48
|
-
*
|
|
49
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
50
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
51
|
-
*/
|
|
52
|
-
route(route: Route): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
53
|
-
/**
|
|
54
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
55
|
-
*
|
|
56
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
57
|
-
* @info Pass second argument to map the input.
|
|
58
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
59
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
60
|
-
*/
|
|
61
|
-
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>;
|
|
62
|
-
/**
|
|
63
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
64
|
-
*
|
|
65
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
66
|
-
* @info Pass second argument to map the input.
|
|
67
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
68
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
69
|
-
*/
|
|
70
|
-
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>;
|
|
71
|
-
/**
|
|
72
|
-
* Make this procedure callable (works like a function while still being a procedure).
|
|
73
|
-
*
|
|
74
|
-
* @see {@link https://orpc.dev/docs/client/server-side Server-side Client Docs}
|
|
75
|
-
*/
|
|
76
|
-
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
77
|
-
/**
|
|
78
|
-
* Make this procedure compatible with server action.
|
|
79
|
-
*
|
|
80
|
-
* @see {@link https://orpc.dev/docs/server-action Server Action Docs}
|
|
81
|
-
*/
|
|
82
|
-
actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
|
|
20
|
+
declare class DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError> extends Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError> {
|
|
21
|
+
meta(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError>;
|
|
22
|
+
errors<T extends ErrorMap>(errors: T): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T>, TReturnedError>;
|
|
23
|
+
use<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): DecoratedProcedure<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, TOutputSchema, MergedErrorMap<$ErrorMap, TErrorMap>, TReturnedError>;
|
|
83
24
|
}
|
|
84
25
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
*/
|
|
111
|
-
'meta'(meta: TMeta): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
112
|
-
/**
|
|
113
|
-
* Sets or updates the route definition.
|
|
114
|
-
* The provided route is spared-merged with any existing route.
|
|
115
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
116
|
-
*
|
|
117
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
118
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
119
|
-
*/
|
|
120
|
-
'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
121
|
-
/**
|
|
122
|
-
* Defines the input validation schema.
|
|
123
|
-
*
|
|
124
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Input Validation Docs}
|
|
125
|
-
*/
|
|
126
|
-
'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
|
|
127
|
-
/**
|
|
128
|
-
* Defines the output validation schema.
|
|
129
|
-
*
|
|
130
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Output Validation Docs}
|
|
131
|
-
*/
|
|
132
|
-
'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
|
|
133
|
-
/**
|
|
134
|
-
* Defines the handler of the procedure.
|
|
135
|
-
*
|
|
136
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
137
|
-
*/
|
|
138
|
-
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
139
|
-
/**
|
|
140
|
-
* Prefixes all procedures in the router.
|
|
141
|
-
* The provided prefix is post-appended to any existing router prefix.
|
|
142
|
-
*
|
|
143
|
-
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
144
|
-
*
|
|
145
|
-
* @see {@link https://orpc.dev/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
146
|
-
*/
|
|
147
|
-
'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
148
|
-
/**
|
|
149
|
-
* Adds tags to all procedures in the router.
|
|
150
|
-
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
151
|
-
*
|
|
152
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
153
|
-
*/
|
|
154
|
-
'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
155
|
-
/**
|
|
156
|
-
* Applies all of the previously defined options to the specified router.
|
|
157
|
-
*
|
|
158
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
159
|
-
*/
|
|
160
|
-
'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
161
|
-
/**
|
|
162
|
-
* Create a lazy router
|
|
163
|
-
* And applies all of the previously defined options to the specified router.
|
|
164
|
-
*
|
|
165
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
166
|
-
*/
|
|
167
|
-
'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
168
|
-
default: U;
|
|
169
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
170
|
-
}
|
|
171
|
-
interface ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
172
|
-
/**
|
|
173
|
-
* This property holds the defined options.
|
|
174
|
-
*/
|
|
175
|
-
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
176
|
-
/**
|
|
177
|
-
* Adds type-safe custom errors.
|
|
178
|
-
* The provided errors are spared-merged with any existing errors.
|
|
179
|
-
*
|
|
180
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
181
|
-
*/
|
|
182
|
-
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
183
|
-
/**
|
|
184
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
185
|
-
*
|
|
186
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
187
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
188
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
189
|
-
*/
|
|
190
|
-
'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>;
|
|
191
|
-
/**
|
|
192
|
-
* Sets or updates the metadata.
|
|
193
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
194
|
-
*
|
|
195
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
196
|
-
*/
|
|
197
|
-
'meta'(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
198
|
-
/**
|
|
199
|
-
* Sets or updates the route definition.
|
|
200
|
-
* The provided route is spared-merged with any existing route.
|
|
201
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
202
|
-
*
|
|
203
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
204
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
205
|
-
*/
|
|
206
|
-
'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
207
|
-
/**
|
|
208
|
-
* Defines the input validation schema.
|
|
209
|
-
*
|
|
210
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Input Validation Docs}
|
|
211
|
-
*/
|
|
212
|
-
'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
|
|
213
|
-
/**
|
|
214
|
-
* Defines the output validation schema.
|
|
215
|
-
*
|
|
216
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Output Validation Docs}
|
|
217
|
-
*/
|
|
218
|
-
'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
|
|
219
|
-
/**
|
|
220
|
-
* Defines the handler of the procedure.
|
|
221
|
-
*
|
|
222
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
223
|
-
*/
|
|
224
|
-
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
225
|
-
}
|
|
226
|
-
interface ProcedureBuilderWithInput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
227
|
-
/**
|
|
228
|
-
* This property holds the defined options.
|
|
229
|
-
*/
|
|
230
|
-
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
231
|
-
/**
|
|
232
|
-
* Adds type-safe custom errors.
|
|
233
|
-
* The provided errors are spared-merged with any existing errors.
|
|
234
|
-
*
|
|
235
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
236
|
-
*/
|
|
237
|
-
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
238
|
-
/**
|
|
239
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
240
|
-
*
|
|
241
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
242
|
-
* @info Pass second argument to map the input.
|
|
243
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
244
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
245
|
-
*/
|
|
246
|
-
'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>;
|
|
247
|
-
/**
|
|
248
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
249
|
-
*
|
|
250
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
251
|
-
* @info Pass second argument to map the input.
|
|
252
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
253
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
254
|
-
*/
|
|
255
|
-
'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>;
|
|
256
|
-
/**
|
|
257
|
-
* Sets or updates the metadata.
|
|
258
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
259
|
-
*
|
|
260
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
261
|
-
*/
|
|
262
|
-
'meta'(meta: TMeta): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
263
|
-
/**
|
|
264
|
-
* Sets or updates the route definition.
|
|
265
|
-
* The provided route is spared-merged with any existing route.
|
|
266
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
267
|
-
*
|
|
268
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
269
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
270
|
-
*/
|
|
271
|
-
'route'(route: Route): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
272
|
-
/**
|
|
273
|
-
* Defines the output validation schema.
|
|
274
|
-
*
|
|
275
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Output Validation Docs}
|
|
276
|
-
*/
|
|
277
|
-
'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
|
|
278
|
-
/**
|
|
279
|
-
* Defines the handler of the procedure.
|
|
280
|
-
*
|
|
281
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
282
|
-
*/
|
|
283
|
-
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
284
|
-
}
|
|
285
|
-
interface ProcedureBuilderWithOutput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
286
|
-
/**
|
|
287
|
-
* This property holds the defined options.
|
|
288
|
-
*/
|
|
289
|
-
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
290
|
-
/**
|
|
291
|
-
* Adds type-safe custom errors.
|
|
292
|
-
* The provided errors are spared-merged with any existing errors.
|
|
293
|
-
*
|
|
294
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
295
|
-
*/
|
|
296
|
-
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
297
|
-
/**
|
|
298
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
299
|
-
*
|
|
300
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
301
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
302
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
303
|
-
*/
|
|
304
|
-
'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>;
|
|
305
|
-
/**
|
|
306
|
-
* Sets or updates the metadata.
|
|
307
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
308
|
-
*
|
|
309
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
310
|
-
*/
|
|
311
|
-
'meta'(meta: TMeta): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
312
|
-
/**
|
|
313
|
-
* Sets or updates the route definition.
|
|
314
|
-
* The provided route is spared-merged with any existing route.
|
|
315
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
316
|
-
*
|
|
317
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
318
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
319
|
-
*/
|
|
320
|
-
'route'(route: Route): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
321
|
-
/**
|
|
322
|
-
* Defines the input validation schema.
|
|
323
|
-
*
|
|
324
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Input Validation Docs}
|
|
325
|
-
*/
|
|
326
|
-
'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
|
|
327
|
-
/**
|
|
328
|
-
* Defines the handler of the procedure.
|
|
329
|
-
*
|
|
330
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
331
|
-
*/
|
|
332
|
-
'handler'(handler: ProcedureHandler<TCurrentContext, unknown, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
333
|
-
}
|
|
334
|
-
interface ProcedureBuilderWithInputOutput<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
335
|
-
/**
|
|
336
|
-
* This property holds the defined options.
|
|
337
|
-
*/
|
|
338
|
-
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
339
|
-
/**
|
|
340
|
-
* Adds type-safe custom errors.
|
|
341
|
-
* The provided errors are spared-merged with any existing errors.
|
|
342
|
-
*
|
|
343
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
344
|
-
*/
|
|
345
|
-
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
346
|
-
/**
|
|
347
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
348
|
-
*
|
|
349
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
350
|
-
* @info Pass second argument to map the input.
|
|
351
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
352
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
353
|
-
*/
|
|
354
|
-
'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>;
|
|
355
|
-
/**
|
|
356
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
357
|
-
*
|
|
358
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
359
|
-
* @info Pass second argument to map the input.
|
|
360
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
361
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
362
|
-
*/
|
|
363
|
-
'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>;
|
|
364
|
-
/**
|
|
365
|
-
* Sets or updates the metadata.
|
|
366
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
367
|
-
*
|
|
368
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
369
|
-
*/
|
|
370
|
-
'meta'(meta: TMeta): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
371
|
-
/**
|
|
372
|
-
* Sets or updates the route definition.
|
|
373
|
-
* The provided route is spared-merged with any existing route.
|
|
374
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
375
|
-
*
|
|
376
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
377
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
378
|
-
*/
|
|
379
|
-
'route'(route: Route): ProcedureBuilderWithInputOutput<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
380
|
-
/**
|
|
381
|
-
* Defines the handler of the procedure.
|
|
382
|
-
*
|
|
383
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
384
|
-
*/
|
|
385
|
-
'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
386
|
-
}
|
|
387
|
-
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
388
|
-
/**
|
|
389
|
-
* This property holds the defined options.
|
|
390
|
-
*/
|
|
391
|
-
'~orpc': EnhanceRouterOptions<TErrorMap>;
|
|
392
|
-
/**
|
|
393
|
-
* Adds type-safe custom errors.
|
|
394
|
-
* The provided errors are spared-merged with any existing errors.
|
|
395
|
-
*
|
|
396
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
397
|
-
*/
|
|
398
|
-
'errors'<U extends ErrorMap>(errors: U): RouterBuilder<TInitialContext, TCurrentContext, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
399
|
-
/**
|
|
400
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
401
|
-
*
|
|
402
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
403
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
404
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
405
|
-
*/
|
|
406
|
-
'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>;
|
|
407
|
-
/**
|
|
408
|
-
* Prefixes all procedures in the router.
|
|
409
|
-
* The provided prefix is post-appended to any existing router prefix.
|
|
410
|
-
*
|
|
411
|
-
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
412
|
-
*
|
|
413
|
-
* @see {@link https://orpc.dev/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
414
|
-
*/
|
|
415
|
-
'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
416
|
-
/**
|
|
417
|
-
* Adds tags to all procedures in the router.
|
|
418
|
-
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
419
|
-
*
|
|
420
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
421
|
-
*/
|
|
422
|
-
'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
423
|
-
/**
|
|
424
|
-
* Applies all of the previously defined options to the specified router.
|
|
425
|
-
*
|
|
426
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
427
|
-
*/
|
|
428
|
-
'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
429
|
-
/**
|
|
430
|
-
* Create a lazy router
|
|
431
|
-
* And applies all of the previously defined options to the specified router.
|
|
432
|
-
*
|
|
433
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
434
|
-
*/
|
|
435
|
-
'lazy'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
436
|
-
default: U;
|
|
437
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
438
|
-
}
|
|
26
|
+
type AugmentedRouter<T extends AnyRouter, TErrorMap extends ErrorMap> = T extends Procedure<infer $InitialContext, infer $CurrentContext, infer $InputSchema, infer $OutputSchema, infer $ErrorMap, infer $ReturnedORPCError> ? Procedure<$InitialContext, $CurrentContext, $InputSchema, $OutputSchema, MergedErrorMap<TErrorMap, $ErrorMap>, $ReturnedORPCError> : {
|
|
27
|
+
[K in keyof T]: T[K] extends Lazy<infer $ extends AnyRouter> ? Lazy<AugmentedRouter<$, TErrorMap>> : T[K] extends AnyRouter ? AugmentedRouter<T[K], TErrorMap> : never;
|
|
28
|
+
};
|
|
29
|
+
type AugmentedRouterWithMiddlewares<T extends AnyRouter, TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> = T extends Procedure<infer $InitialContext, infer $CurrentContext, infer $InputSchema, infer $OutputSchema, infer $ErrorMap, infer $ReturnedORPCError> ? Procedure<MergedInitialContext<TInitialContext, TInjectedContext, $InitialContext>, $CurrentContext, $InputSchema, $OutputSchema, MergedErrorMap<TErrorMap, $ErrorMap>, $ReturnedORPCError> : {
|
|
30
|
+
[K in keyof T]: T[K] extends Lazy<infer $ extends AnyRouter> ? Lazy<AugmentedRouterWithMiddlewares<$, TInitialContext, TInjectedContext, TErrorMap>> : T[K] extends AnyRouter ? AugmentedRouterWithMiddlewares<T[K], TInitialContext, TInjectedContext, TErrorMap> : never;
|
|
31
|
+
};
|
|
32
|
+
interface AugmentRouterOptions<TErrorMap extends ErrorMap> extends AugmentContractRouterOptions<TErrorMap> {
|
|
33
|
+
middlewares: AnyMiddleware[];
|
|
34
|
+
}
|
|
35
|
+
declare function augmentRouter<T extends AnyRouter, TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap>(router: T, options: AugmentRouterOptions<TErrorMap>): AugmentedRouter<T, TErrorMap> | AugmentedRouterWithMiddlewares<T, TInitialContext, TCurrentContext, TErrorMap>;
|
|
36
|
+
interface AugmentImplementedRouterOptions {
|
|
37
|
+
middlewares: AnyMiddleware[];
|
|
38
|
+
}
|
|
39
|
+
declare function augmentImplementedRouter<T extends AnyRouter, TInitialContext extends Context, TCurrentContext extends Context>(router: T, options: AugmentImplementedRouterOptions): AugmentedRouter<T, object> | AugmentedRouterWithMiddlewares<T, TInitialContext, TCurrentContext, object>;
|
|
40
|
+
declare function getRouter<T extends Lazyable<AnyRouter | undefined>>(router: T, path: readonly string[]): T extends Lazy<any> ? Lazy<AnyRouter | undefined> : Lazyable<AnyRouter | undefined>;
|
|
41
|
+
interface WalkProcedureContractsLazyResult {
|
|
42
|
+
router: Lazy<AnyRouter>;
|
|
43
|
+
path: string[];
|
|
44
|
+
}
|
|
45
|
+
declare function walkProcedureContractsSync(router: RouterContract | AnyRouter, callback: (contract: AnyProcedureContract | AnyProcedure, path: string[]) => void, path?: string[]): WalkProcedureContractsLazyResult[];
|
|
46
|
+
declare function walkProcedureContractsAsync(router: RouterContract | AnyRouter, callback: (contract: AnyProcedureContract | AnyProcedure, path: string[]) => Promisable<void>, path?: string[]): Promise<void>;
|
|
47
|
+
type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
|
|
48
|
+
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? UnlaziedRouter<U> : never;
|
|
49
|
+
};
|
|
50
|
+
declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
|
|
439
51
|
|
|
440
|
-
interface
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
52
|
+
interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
|
|
53
|
+
'~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
|
|
54
|
+
'meta'(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithMiddlewares<TInitialContext, TInjectedContext, TErrorMap>;
|
|
55
|
+
'errors'<T extends ErrorMap>(errors: T): BuilderWithMiddlewares<TInitialContext, TInjectedContext, MergedErrorMap<TErrorMap, T>>;
|
|
56
|
+
'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
57
|
+
'middleware'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $Input, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $Output = any>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, $Input, $Output, TErrorMap>): DecoratedMiddleware<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, $Input, $Output, TErrorMap>;
|
|
58
|
+
'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, T, TErrorMap>;
|
|
59
|
+
'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, T, TErrorMap>;
|
|
60
|
+
'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
|
|
61
|
+
'router'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(router: T): AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>;
|
|
62
|
+
'lazy'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(loader: () => Promise<{
|
|
63
|
+
default: T;
|
|
64
|
+
}>): Lazy<AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>>;
|
|
65
|
+
}
|
|
66
|
+
interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
67
|
+
'~orpc': BuilderDefinition<TInputSchema, InitialOutputSchema, TErrorMap>;
|
|
68
|
+
'meta'(...plugins: MetaPlugin<TInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, TErrorMap>;
|
|
69
|
+
'errors'<T extends ErrorMap>(errors: T): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
70
|
+
'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithInput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
71
|
+
'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TErrorMap>;
|
|
72
|
+
'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, T, TErrorMap>;
|
|
73
|
+
'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
|
|
74
|
+
}
|
|
75
|
+
interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
76
|
+
'~orpc': BuilderDefinition<InitialInputSchema, TOutputSchema, TErrorMap>;
|
|
77
|
+
'meta'(...plugins: MetaPlugin<InitialInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, TErrorMap>;
|
|
78
|
+
'errors'<T extends ErrorMap>(errors: T): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
79
|
+
'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): BuilderWithOutput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TOutputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
80
|
+
'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, T, TOutputSchema, TErrorMap>;
|
|
81
|
+
'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, MergedSchema<T, TOutputSchema>, TErrorMap>;
|
|
82
|
+
'handler'<T extends InferSchemaInput<TOutputSchema> | AnyORPCError>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, TOutputSchema, TErrorMap, Extract<T, AnyORPCError>>;
|
|
83
|
+
}
|
|
84
|
+
interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
85
|
+
'~orpc': BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>;
|
|
86
|
+
'meta'(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
87
|
+
'errors'<T extends ErrorMap>(errors: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
88
|
+
'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): BuilderWithInputOutput<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, TOutputSchema, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
89
|
+
'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TOutputSchema, TErrorMap>;
|
|
90
|
+
'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, MergedSchema<T, TOutputSchema>, TErrorMap>;
|
|
91
|
+
'handler'<T extends InferSchemaInput<TOutputSchema> | AnyORPCError>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, Extract<T, AnyORPCError>>;
|
|
459
92
|
}
|
|
460
|
-
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>;
|
|
461
93
|
|
|
462
|
-
interface
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
}
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
$config(config: BuilderConfig): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
486
|
-
/**
|
|
487
|
-
* Set or override the initial context.
|
|
488
|
-
*
|
|
489
|
-
* @see {@link https://orpc.dev/docs/context Context Docs}
|
|
490
|
-
*/
|
|
491
|
-
$context<U extends Context>(): Builder<U & Record<never, never>, U, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
492
|
-
/**
|
|
493
|
-
* Sets or overrides the initial meta.
|
|
494
|
-
*
|
|
495
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
496
|
-
*/
|
|
497
|
-
$meta<U extends Meta>(initialMeta: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
|
|
498
|
-
/**
|
|
499
|
-
* Sets or overrides the initial route.
|
|
500
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
501
|
-
*
|
|
502
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
503
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
504
|
-
*/
|
|
505
|
-
$route(initialRoute: Route): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
506
|
-
/**
|
|
507
|
-
* Sets or overrides the initial input schema.
|
|
508
|
-
*
|
|
509
|
-
* @see {@link https://orpc.dev/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
|
|
510
|
-
*/
|
|
511
|
-
$input<U extends AnySchema>(initialInputSchema?: U): Builder<TInitialContext, TCurrentContext, U, TOutputSchema, TErrorMap, TMeta>;
|
|
512
|
-
/**
|
|
513
|
-
* Creates a middleware.
|
|
514
|
-
*
|
|
515
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
516
|
-
*/
|
|
517
|
-
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
518
|
-
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>, TMeta>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, TMeta>;
|
|
519
|
-
/**
|
|
520
|
-
* Adds type-safe custom errors.
|
|
521
|
-
* The provided errors are spared-merged with any existing errors.
|
|
522
|
-
*
|
|
523
|
-
* @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
524
|
-
*/
|
|
525
|
-
errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
526
|
-
/**
|
|
527
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
528
|
-
*
|
|
529
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
530
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
531
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
532
|
-
*/
|
|
533
|
-
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>;
|
|
534
|
-
/**
|
|
535
|
-
* Sets or updates the metadata.
|
|
536
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
537
|
-
*
|
|
538
|
-
* @see {@link https://orpc.dev/docs/metadata Metadata Docs}
|
|
539
|
-
*/
|
|
540
|
-
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
541
|
-
/**
|
|
542
|
-
* Sets or updates the route definition.
|
|
543
|
-
* The provided route is spared-merged with any existing route.
|
|
544
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
545
|
-
*
|
|
546
|
-
* @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
|
|
547
|
-
* @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
548
|
-
*/
|
|
549
|
-
route(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
550
|
-
/**
|
|
551
|
-
* Defines the input validation schema.
|
|
552
|
-
*
|
|
553
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Input Validation Docs}
|
|
554
|
-
*/
|
|
555
|
-
input<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithInput<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta>;
|
|
556
|
-
/**
|
|
557
|
-
* Defines the output validation schema.
|
|
558
|
-
*
|
|
559
|
-
* @see {@link https://orpc.dev/docs/procedure#input-output-validation Output Validation Docs}
|
|
560
|
-
*/
|
|
561
|
-
output<USchema extends AnySchema>(schema: USchema): ProcedureBuilderWithOutput<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta>;
|
|
562
|
-
/**
|
|
563
|
-
* Defines the handler of the procedure.
|
|
564
|
-
*
|
|
565
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
566
|
-
*/
|
|
567
|
-
handler<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, unknown, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
568
|
-
/**
|
|
569
|
-
* Prefixes all procedures in the router.
|
|
570
|
-
* The provided prefix is post-appended to any existing router prefix.
|
|
571
|
-
*
|
|
572
|
-
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
573
|
-
*
|
|
574
|
-
* @see {@link https://orpc.dev/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
575
|
-
*/
|
|
576
|
-
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
577
|
-
/**
|
|
578
|
-
* Adds tags to all procedures in the router.
|
|
579
|
-
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
580
|
-
*
|
|
581
|
-
* @see {@link https://orpc.dev/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
582
|
-
*/
|
|
583
|
-
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
584
|
-
/**
|
|
585
|
-
* Applies all of the previously defined options to the specified router.
|
|
586
|
-
*
|
|
587
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
588
|
-
*/
|
|
589
|
-
router<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
590
|
-
/**
|
|
591
|
-
* Create a lazy router
|
|
592
|
-
* And applies all of the previously defined options to the specified router.
|
|
593
|
-
*
|
|
594
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
595
|
-
*/
|
|
596
|
-
lazy<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
597
|
-
default: U;
|
|
598
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
599
|
-
}
|
|
600
|
-
declare const os: Builder<Record<never, never>, Record<never, never>, Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
|
|
94
|
+
interface DefaultInitialContext {
|
|
95
|
+
}
|
|
96
|
+
interface BuilderDefinition<TInputSchema extends AnySchema, TInjectedContext extends AnySchema, TErrorMap extends ErrorMap> extends ProcedureContractDefinition<TInputSchema, TInjectedContext, TErrorMap> {
|
|
97
|
+
orderedMiddlewares: OrderedMiddleware[];
|
|
98
|
+
}
|
|
99
|
+
declare class Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
|
100
|
+
'~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
|
|
101
|
+
private constructor();
|
|
102
|
+
static create<T extends Context = DefaultInitialContext>(): Builder<T & object, Record<never, never>>;
|
|
103
|
+
$context<T extends Context = DefaultInitialContext>(): Builder<T & object, TErrorMap>;
|
|
104
|
+
meta(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): Builder<TInitialContext, TErrorMap>;
|
|
105
|
+
errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, MergedErrorMap<TErrorMap, U>>;
|
|
106
|
+
use<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $InContext extends Context = TInitialContext, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | TInitialContext, $OutContext, InferSchemaOutput<InitialInputSchema>, InferSchemaInput<InitialOutputSchema>, $ErrorMap>): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, object, $InContext>, $OutContext, MergedErrorMap<$ErrorMap, TErrorMap>>;
|
|
107
|
+
middleware<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $Input, $Output = any>(middleware: Middleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>): DecoratedMiddleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>;
|
|
108
|
+
input<$ extends AnySchema>(schema: $): BuilderWithInput<TInitialContext, object, $, TErrorMap>;
|
|
109
|
+
output<$ extends AnySchema>(schema: $): BuilderWithOutput<TInitialContext, object, $, TErrorMap>;
|
|
110
|
+
handler<T>(handler: ProcedureHandler<TInitialContext, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, object, InitialInputSchema, Schema<Exclude<T, AnyORPCError>>, TErrorMap, Extract<T, AnyORPCError>>;
|
|
111
|
+
router<T extends AnyRouter>(router: T): AugmentedRouter<T, TErrorMap>;
|
|
112
|
+
lazy<T extends AnyRouter>(loader: () => Promise<{
|
|
113
|
+
default: T;
|
|
114
|
+
}>): Lazy<AugmentedRouter<T, TErrorMap>>;
|
|
115
|
+
}
|
|
116
|
+
declare const os: Builder<DefaultInitialContext & object, Record<never, never>>;
|
|
601
117
|
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
initialOutputValidationIndex: number;
|
|
605
|
-
dedupeLeadingMiddlewares: boolean;
|
|
606
|
-
}
|
|
607
|
-
declare function fallbackConfig<T extends keyof Config>(key: T, value?: Config[T]): Config[T];
|
|
118
|
+
declare const DEFAULT_SUCCESS_STATUS = 200;
|
|
119
|
+
declare const DEFAULT_ERROR_STATUS = 500;
|
|
608
120
|
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
615
|
-
*
|
|
616
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
617
|
-
* @info Pass second argument to map the input.
|
|
618
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
619
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
620
|
-
*/
|
|
621
|
-
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>;
|
|
622
|
-
/**
|
|
623
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
624
|
-
*
|
|
625
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
626
|
-
* @info Pass second argument to map the input.
|
|
627
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
628
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
629
|
-
*/
|
|
630
|
-
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>;
|
|
631
|
-
/**
|
|
632
|
-
* Make this procedure callable (works like a function while still being a procedure).
|
|
633
|
-
*
|
|
634
|
-
* @see {@link https://orpc.dev/docs/client/server-side Server-side Client Docs}
|
|
635
|
-
*/
|
|
636
|
-
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
637
|
-
/**
|
|
638
|
-
* Make this procedure compatible with server action.
|
|
639
|
-
*
|
|
640
|
-
* @see {@link https://orpc.dev/docs/server-action Server Action Docs}
|
|
641
|
-
*/
|
|
642
|
-
actionable(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureActionableClient<TInputSchema, TOutputSchema, TErrorMap>;
|
|
121
|
+
declare class ProcedureImplementer<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
122
|
+
'~orpc': BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>;
|
|
123
|
+
constructor(definition: BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>);
|
|
124
|
+
'use'<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): ProcedureImplementer<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, TOutputSchema, TErrorMap>;
|
|
125
|
+
'handler'(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, AnyORPCError | InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>>): ImplementedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
643
126
|
}
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
*/
|
|
647
|
-
interface ProcedureImplementer<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
648
|
-
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
649
|
-
/**
|
|
650
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
651
|
-
*
|
|
652
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
653
|
-
* @info Pass second argument to map the input.
|
|
654
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
655
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
656
|
-
*/
|
|
657
|
-
'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>;
|
|
658
|
-
/**
|
|
659
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
660
|
-
*
|
|
661
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
662
|
-
* @info Pass second argument to map the input.
|
|
663
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
664
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
665
|
-
*/
|
|
666
|
-
'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>;
|
|
667
|
-
/**
|
|
668
|
-
* Defines the handler of the procedure.
|
|
669
|
-
*
|
|
670
|
-
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
671
|
-
*/
|
|
672
|
-
'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
127
|
+
declare class ImplementedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, never> {
|
|
128
|
+
use<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = TErrorMap>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, $ErrorMap>): ImplementedProcedure<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, TInputSchema, TOutputSchema, TErrorMap>;
|
|
673
129
|
}
|
|
674
130
|
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
lazy<U extends Router<T, TInitialContext>>(loader: () => Promise<{
|
|
699
|
-
default: U;
|
|
700
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
701
|
-
}
|
|
702
|
-
type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementerWithMiddlewares<TContract, TInitialContext, TCurrentContext> & {
|
|
703
|
-
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternalWithMiddlewares<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
131
|
+
declare class SharedRouterImplementer<TContract extends RouterContract, TInitialContext extends Context> {
|
|
132
|
+
private readonly contract;
|
|
133
|
+
private readonly middlewares;
|
|
134
|
+
private constructor();
|
|
135
|
+
static create<TContract extends RouterContract, TInitialContext extends Context>(contract: TContract): SharedRouterImplementer<TContract, TInitialContext>;
|
|
136
|
+
static create<TContract extends RouterContract, TInitialContext extends Context, TInjectedContext extends Context>(contract: TContract, middlewares: AnyMiddleware[]): SharedRouterImplementerWithMiddlewares<TContract, TInitialContext, TInjectedContext>;
|
|
137
|
+
use<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $InContext extends Context = TInitialContext, $ErrorMap extends ErrorMap = InferRouterContractErrorMap<TContract>>(middleware: Middleware<$InContext | TInitialContext, $OutContext, unknown, unknown, $ErrorMap>): RouterImplementerWithMiddlewares<TContract, MergedInitialContext<TInitialContext, object, $InContext>, $OutContext>;
|
|
138
|
+
middleware<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $Input, $InContext extends Context = TInitialContext, $Output = any>(middleware: Middleware<$InContext | TInitialContext, $OutContext, $Input, $Output, InferRouterContractErrorMap<TContract>>): DecoratedMiddleware<MergedInitialContext<TInitialContext, object, $InContext>, $OutContext, $Input, $Output, object>;
|
|
139
|
+
router<T extends ContractedRouter<TContract, any>>(router: T): T;
|
|
140
|
+
lazy<T extends ContractedRouter<TContract, any>>(loader: () => Promise<{
|
|
141
|
+
default: T;
|
|
142
|
+
}>): Lazy<T>;
|
|
143
|
+
}
|
|
144
|
+
interface SharedRouterImplementerWithMiddlewares<TContract extends RouterContract, TInitialContext extends Context, TInjectedContext extends Context> {
|
|
145
|
+
use<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $ErrorMap extends ErrorMap = InferRouterContractErrorMap<TContract>>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, unknown, unknown, $ErrorMap>): RouterImplementerWithMiddlewares<TContract, MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>>;
|
|
146
|
+
middleware<$OutContext extends IntersectPick<MergedContext<TInitialContext, TInjectedContext>, $OutContext>, $Input, $InContext extends Context = MergedContext<TInitialContext, TInjectedContext>, $Output = any>(middleware: Middleware<$InContext | MergedContext<TInitialContext, TInjectedContext>, $OutContext, $Input, $Output, InferRouterContractErrorMap<TContract>>): DecoratedMiddleware<MergedInitialContext<TInitialContext, TInjectedContext, $InContext>, MergedContext<TInjectedContext, $OutContext>, $Input, $Output, object>;
|
|
147
|
+
router<T extends ContractedRouter<TContract, MergedContext<TInitialContext, TInjectedContext>>>(router: T): AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, object>;
|
|
148
|
+
lazy<T extends ContractedRouter<TContract, any>>(loader: () => Promise<{
|
|
149
|
+
default: T;
|
|
150
|
+
}>): Lazy<AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, object>>;
|
|
151
|
+
}
|
|
152
|
+
type RouterImplementer<TContract extends RouterContract, TInitialContext extends Context> = TContract extends ProcedureContract<infer $InputSchema, infer $OutputSchema, infer $ErrorMap> ? ProcedureImplementer<TInitialContext, object, $InputSchema, $OutputSchema, $ErrorMap> : Public<SharedRouterImplementer<TContract, TInitialContext>> & {
|
|
153
|
+
[K in keyof TContract]: TContract[K] extends RouterContract ? RouterImplementer<TContract[K], TInitialContext> : never;
|
|
704
154
|
};
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
/**
|
|
708
|
-
* Creates a middleware.
|
|
709
|
-
*
|
|
710
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
711
|
-
*/
|
|
712
|
-
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
713
|
-
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, InferContractRouterMeta<T>>;
|
|
714
|
-
/**
|
|
715
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
716
|
-
*
|
|
717
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
718
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
719
|
-
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
720
|
-
*/
|
|
721
|
-
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>>;
|
|
722
|
-
/**
|
|
723
|
-
* Applies all of the previously defined options to the specified router.
|
|
724
|
-
* And enforces the router match the contract.
|
|
725
|
-
*
|
|
726
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
727
|
-
*/
|
|
728
|
-
router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
729
|
-
/**
|
|
730
|
-
* Create a lazy router
|
|
731
|
-
* And applies all of the previously defined options to the specified router.
|
|
732
|
-
* And enforces the router match the contract.
|
|
733
|
-
*
|
|
734
|
-
* @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
|
|
735
|
-
*/
|
|
736
|
-
lazy<U extends Router<T, TCurrentContext>>(loader: () => Promise<{
|
|
737
|
-
default: U;
|
|
738
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
739
|
-
}
|
|
740
|
-
type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementer<TContract, TInitialContext, TCurrentContext> & {
|
|
741
|
-
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternal<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
155
|
+
type RouterImplementerWithMiddlewares<TContract extends RouterContract, TInitialContext extends Context, TInjectedContext extends Context> = TContract extends ProcedureContract<infer $InputSchema, infer $OutputSchema, infer $ErrorMap> ? ProcedureImplementer<TInitialContext, TInjectedContext, $InputSchema, $OutputSchema, $ErrorMap> : SharedRouterImplementerWithMiddlewares<TContract, TInitialContext, TInjectedContext> & {
|
|
156
|
+
[K in keyof TContract]: TContract[K] extends RouterContract ? RouterImplementerWithMiddlewares<TContract[K], TInitialContext, TInjectedContext> : never;
|
|
742
157
|
};
|
|
743
|
-
declare function
|
|
744
|
-
type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
|
|
745
|
-
/**
|
|
746
|
-
* Set or override the initial context.
|
|
747
|
-
*
|
|
748
|
-
* @see {@link https://orpc.dev/docs/context Context Docs}
|
|
749
|
-
*/
|
|
750
|
-
$context<U extends Context>(): Implementer<TContract, U & Record<never, never>, U>;
|
|
751
|
-
/**
|
|
752
|
-
* Sets or overrides the config.
|
|
753
|
-
*
|
|
754
|
-
* @see {@link https://orpc.dev/docs/client/server-side#middlewares-order Middlewares Order Docs}
|
|
755
|
-
* @see {@link https://orpc.dev/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
|
756
|
-
*/
|
|
757
|
-
$config(config: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
|
|
758
|
-
} & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
|
|
759
|
-
declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
|
|
760
|
-
|
|
761
|
-
/**
|
|
762
|
-
* Help RPCLink automatically send requests using the specified HTTP method in the router.
|
|
763
|
-
*/
|
|
764
|
-
declare function inferRPCMethodFromRouter(router: AnyRouter): (options: unknown, path: readonly string[]) => Promise<Exclude<HTTPMethod, 'HEAD'>>;
|
|
158
|
+
declare function createRouterImplementer<TContract extends RouterContract, TInitialContext extends Context>(contract: TContract): RouterImplementer<TContract, TInitialContext>;
|
|
765
159
|
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
declare function addMiddleware(middlewares: readonly AnyMiddleware[], addition: AnyMiddleware): AnyMiddleware[];
|
|
160
|
+
type Implementer<TContract extends RouterContract, TInitialContext extends Context> = {
|
|
161
|
+
$context<T extends Context = DefaultInitialContext>(): Implementer<TContract, T & object>;
|
|
162
|
+
} & RouterImplementer<TContract, TInitialContext>;
|
|
163
|
+
declare function implement<TContract extends RouterContract, TInitialContext extends Context = DefaultInitialContext>(contract: TContract): Implementer<TContract, TInitialContext & object>;
|
|
771
164
|
|
|
772
|
-
declare function
|
|
165
|
+
declare function createGuardedProcedureLazy(lazy: Lazy<unknown>): Lazy<AnyProcedure>;
|
|
773
166
|
/**
|
|
774
167
|
* Create a new procedure that ensure the contract is applied to the procedure.
|
|
168
|
+
*
|
|
169
|
+
* .input/.output/.handler mismatches are already caught by the `implementer.router`,
|
|
170
|
+
* but .errors (in case implemented procedure error map is more than enough) and .meta cannot be
|
|
171
|
+
* validated that way - so they must be overridden here to ensure the client always sees what the contract defines.
|
|
775
172
|
*/
|
|
776
|
-
declare function
|
|
173
|
+
declare function createContractProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(procedure: Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, any, any>, contract: ProcedureContract<any, any, TErrorMap>): Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap, never>;
|
|
174
|
+
type CallOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError> = ProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError, object> & Omit<ClientOptions<object>, 'context'>;
|
|
175
|
+
type CallRest<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError> = object extends CallOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError> ? undefined extends InferSchemaInput<TInputSchema> ? [input?: InferSchemaInput<TInputSchema>, options?: CallOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError>] : [input: InferSchemaInput<TInputSchema>, options?: CallOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError>] : [input: InferSchemaInput<TInputSchema>, options: CallOptions<TInitialContext, TOutputSchema, TErrorMap, TReturnedError>];
|
|
777
176
|
/**
|
|
778
|
-
*
|
|
177
|
+
* Quickly call a procedure without creating a client.
|
|
779
178
|
*
|
|
780
179
|
* @example
|
|
781
180
|
* ```ts
|
|
782
181
|
* const output = await call(getting, 'input')
|
|
783
182
|
* const output = await call(getting, 'input', { context: { db: 'postgres' } })
|
|
784
183
|
* ```
|
|
785
|
-
*
|
|
786
184
|
*/
|
|
787
|
-
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap,
|
|
185
|
+
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TReturnedError extends AnyORPCError>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TReturnedError>>, ...[input, options,]: CallRest<TInitialContext, TInputSchema, TOutputSchema, TErrorMap, TReturnedError>): PromiseWithError<InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | TReturnedError | ThrowableError>;
|
|
788
186
|
|
|
789
|
-
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext =
|
|
187
|
+
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = object> = TRouter extends Procedure<any, any, infer $InputSchema, infer $OutputSchema, infer $ErrorMap, infer $ReturnedError> ? ProcedureClient<TClientContext, $InputSchema, $OutputSchema, $ErrorMap, $ReturnedError> : {
|
|
790
188
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
|
791
189
|
};
|
|
792
|
-
|
|
793
|
-
* Create Server-side client from a router.
|
|
794
|
-
*
|
|
795
|
-
* @see {@link https://orpc.dev/docs/client/server-side Server-side Client Docs}
|
|
796
|
-
*/
|
|
797
|
-
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>;
|
|
190
|
+
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext = object>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<ProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown>, ErrorMap, any, TClientContext>>): RouterClient<T, TClientContext>;
|
|
798
191
|
|
|
799
|
-
declare function
|
|
800
|
-
declare function getHiddenRouterContract(router: Lazyable<AnyRouter |
|
|
192
|
+
declare function withHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: RouterContract): T;
|
|
193
|
+
declare function getHiddenRouterContract(router: Lazyable<AnyRouter | RouterContract>): RouterContract | undefined;
|
|
801
194
|
|
|
802
|
-
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context,
|
|
803
|
-
export type {
|
|
195
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, ContractedRouter, DEFAULT_ERROR_STATUS, DEFAULT_SUCCESS_STATUS, DecoratedProcedure, ImplementedProcedure, InferRouterInitialContext, Lazy, Lazyable, MergedContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, OrderedMiddleware, Procedure, ProcedureClient, ProcedureClientOptions, ProcedureHandler, ProcedureImplementer, Router, SharedRouterImplementer, augmentImplementedRouter, augmentRouter, call, createContractProcedure, createGuardedProcedureLazy, createRouterClient, createRouterImplementer, decorateMiddleware, getHiddenRouterContract, getRouter, implement, os, unlazyRouter, walkProcedureContractsAsync, walkProcedureContractsSync, withHiddenRouterContract };
|
|
196
|
+
export type { AugmentImplementedRouterOptions, AugmentRouterOptions, AugmentedRouter, AugmentedRouterWithMiddlewares, BuilderDefinition, BuilderWithInput, BuilderWithInputOutput, BuilderWithMiddlewares, BuilderWithOutput, CallOptions, CallRest, DecoratedMiddleware, DefaultInitialContext, Implementer, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, SharedRouterImplementerWithMiddlewares, UnlaziedRouter, WalkProcedureContractsLazyResult };
|