@orpc/server 2.0.0-beta.4 → 2.0.0-beta.40
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 +97 -94
- package/dist/adapters/aws-lambda/index.d.mts +50 -0
- package/dist/adapters/aws-lambda/index.d.ts +50 -0
- package/dist/adapters/aws-lambda/index.mjs +39 -0
- package/dist/adapters/crossws/index.d.mts +21 -12
- package/dist/adapters/crossws/index.d.ts +21 -12
- package/dist/adapters/crossws/index.mjs +14 -10
- package/dist/adapters/fastify/index.d.mts +42 -0
- package/dist/adapters/fastify/index.d.ts +42 -0
- package/dist/adapters/fastify/index.mjs +39 -0
- package/dist/adapters/fetch/index.d.mts +21 -114
- package/dist/adapters/fetch/index.d.ts +21 -114
- package/dist/adapters/fetch/index.mjs +20 -182
- package/dist/adapters/message-port/index.d.mts +23 -20
- package/dist/adapters/message-port/index.d.ts +23 -20
- package/dist/adapters/message-port/index.mjs +31 -34
- package/dist/adapters/node/index.d.mts +19 -96
- package/dist/adapters/node/index.d.ts +19 -96
- package/dist/adapters/node/index.mjs +19 -157
- package/dist/adapters/standard/index.d.mts +91 -17
- package/dist/adapters/standard/index.d.ts +91 -17
- package/dist/adapters/standard/index.mjs +4 -4
- package/dist/adapters/standard-peer/index.d.mts +6 -11
- package/dist/adapters/standard-peer/index.d.ts +6 -11
- package/dist/adapters/standard-peer/index.mjs +10 -2
- package/dist/adapters/websocket/index.d.mts +45 -29
- package/dist/adapters/websocket/index.d.ts +45 -29
- package/dist/adapters/websocket/index.mjs +37 -28
- package/dist/extensions/callable.d.mts +5 -5
- package/dist/extensions/callable.d.ts +5 -5
- package/dist/extensions/callable.mjs +2 -2
- package/dist/helpers/index.d.mts +23 -6
- package/dist/helpers/index.d.ts +23 -6
- package/dist/helpers/index.mjs +13 -5
- package/dist/index.d.mts +332 -37
- package/dist/index.d.ts +332 -37
- package/dist/index.mjs +131 -49
- package/dist/plugins/index.d.mts +243 -31
- package/dist/plugins/index.d.ts +243 -31
- package/dist/plugins/index.mjs +527 -30
- package/dist/shared/server.1ExWFMze.mjs +69 -0
- package/dist/shared/{server.CjOb6ItT.mjs → server.24nXyhbl.mjs} +1 -1
- package/dist/shared/{server.DBANIheG.d.ts → server.B5K1CViq.d.mts} +24 -13
- package/dist/shared/{server.BsNNjG5J.d.mts → server.BpmUhems.d.mts} +32 -20
- package/dist/shared/{server.BL22TloH.d.mts → server.BsujoJoF.d.mts} +38 -59
- package/dist/shared/{server.BL22TloH.d.ts → server.BsujoJoF.d.ts} +38 -59
- package/dist/shared/{server.BwHnWUuN.mjs → server.BynNaBBA.mjs} +24 -19
- package/dist/shared/{server.GDpX6Df8.mjs → server.C0lFtoHU.mjs} +162 -68
- package/dist/shared/server.C7xllBNN.d.mts +34 -0
- package/dist/shared/server.CFqSIFnT.d.mts +14 -0
- package/dist/shared/{server.Pa0F03f_.d.ts → server.CRwPbhLO.d.ts} +32 -20
- package/dist/shared/{server.DJIkub_t.d.mts → server.Cxranw-8.d.ts} +24 -13
- package/dist/shared/server.D0dr-F8u.d.ts +34 -0
- package/dist/shared/{server.CrlKQucM.mjs → server.Djb_ebJT.mjs} +25 -53
- package/dist/shared/server.RRVK1xTV.d.ts +14 -0
- package/package.json +47 -14
- package/dist/shared/server.CX4vUnDk.mjs +0 -11
- package/dist/shared/server.Cj5lgPuG.d.mts +0 -66
- package/dist/shared/server.D_QauotT.mjs +0 -30
- package/dist/shared/server.d_2NS3g5.d.ts +0 -66
package/dist/index.d.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
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';
|
|
1
|
+
import { ErrorMap, MergedErrorMap, AnySchema, MetaPlugin, InferSchemaOutput, InferSchemaInput, AugmentContractRouterOptions, RouterContract, AnyProcedureContract, InitialInputSchema, InitialOutputSchema, MergedSchema, ORPCErrorConstructorMap, Schema, ProcedureContractDefinition, ProcedureContract, InferRouterContractErrorMap, ORPCErrorFromErrorMap } from '@orpc/contract';
|
|
2
|
+
export { AnyMetaPlugin, AnySchema, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InitialInputSchema, InitialOutputSchema, MergedErrorMap, Meta, MetaPlugin, MetaPluginDefinition, ORPCErrorConstructorMap, ORPCErrorConstructorMapItem, ORPCErrorConstructorMapItemOptions, ORPCErrorFactory, ORPCErrorFactoryOptions, ORPCErrorFromErrorMap, ProcedureContract, ProcedureContractDefinition, RouterContract, Schema, ValidationError, asyncIteratorObject, defineMeta, error, eventIterator, reconcileORPCError, type } from '@orpc/contract';
|
|
5
3
|
import { IntersectPick, Promisable, Public, PromiseWithError, ThrowableError, MaybeOptionalOptions } from '@orpc/shared';
|
|
6
|
-
export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, MaybeOptionalOptions, PromiseWithError, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess,
|
|
7
|
-
import { C as Context, d as Middleware, M as MergedContext, e as MergedInitialContext, a as Procedure, f as
|
|
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,
|
|
9
|
-
import { A as AnyRouter, R as Router, C as ContractedRouter, I as InferRouterInitialContext } from './shared/server.
|
|
10
|
-
export { a as
|
|
11
|
-
|
|
4
|
+
export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, MaybeOptionalOptions, PromiseWithError, Registry, ThrowableError, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
|
|
5
|
+
import { C as Context, d as Middleware, M as MergedContext, e as MergedInitialContext, a as Procedure, f as ProcedureConfig, g as AnyMiddleware, h as Lazy, A as AnyProcedure, L as Lazyable, i as ProcedureHandler, O as OrderedMiddleware, P as ProcedureClientOptions, b as ProcedureClient } from './shared/server.BsujoJoF.js';
|
|
6
|
+
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, c as ProcedureClientInterceptor, r as ProcedureClientInterceptorOptions, s as ProcedureDefinition, t as ProcedureHandlerOptions, u as createProcedureClient, v as unlazy } from './shared/server.BsujoJoF.js';
|
|
7
|
+
import { A as AnyRouter, R as Router, C as ContractedRouter, I as InferRouterInitialContext } from './shared/server.CRwPbhLO.js';
|
|
8
|
+
export { a as InferRouterCurrentContexts, b as InferRouterError, c as InferRouterErrors, a as InferRouterFinalContexts, d as InferRouterInitialContexts, e as InferRouterInputs, f as InferRouterOutputs } from './shared/server.CRwPbhLO.js';
|
|
9
|
+
import { ClientOptions, ClientContext } from '@orpc/client';
|
|
10
|
+
export { AnyORPCError, AnyORPCErrorJSON, COMMON_ERROR_STATUS_MAP, Client, ClientContext, ClientOptions, ClientRest, FriendlyClientOptions, ORPCError, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, RPCJsonSerialization, RPCJsonSerializationMeta, RPCJsonSerializer, RPCJsonSerializerHandler, RPCJsonSerializerOptions, RPCSerializer, RPCSerializerOptions, RPCSerializerSerializeOptions, SafeResult, cloneORPCError, isDefinedError, safe, toORPCError } from '@orpc/client';
|
|
11
|
+
export { ErrorEvent, EventMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
|
|
12
12
|
|
|
13
13
|
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorMap extends ErrorMap> extends Middleware<TInContext, TOutContext, TInput, TOutput, TErrorMap> {
|
|
14
14
|
adaptInput<T>(adapt: (input: T) => TInput): DecoratedMiddleware<TInContext, TOutContext, T, TOutput, TErrorMap>;
|
|
@@ -17,23 +17,23 @@ interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Co
|
|
|
17
17
|
}
|
|
18
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>;
|
|
19
19
|
|
|
20
|
-
declare class DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap
|
|
21
|
-
meta(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap
|
|
22
|
-
errors<T extends ErrorMap>(errors: T): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T
|
|
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
|
|
20
|
+
declare class DecoratedProcedure<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> extends Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap> {
|
|
21
|
+
meta(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
22
|
+
errors<T extends ErrorMap>(errors: T): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
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>>;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
|
-
type AugmentedRouter<T extends AnyRouter, TErrorMap extends ErrorMap> = T extends Procedure<infer $InitialContext, infer $CurrentContext, infer $InputSchema, infer $OutputSchema, infer $ErrorMap
|
|
26
|
+
type AugmentedRouter<T extends AnyRouter, TErrorMap extends ErrorMap> = T extends Procedure<infer $InitialContext, infer $CurrentContext, infer $InputSchema, infer $OutputSchema, infer $ErrorMap> ? Procedure<$InitialContext, $CurrentContext, $InputSchema, $OutputSchema, MergedErrorMap<TErrorMap, $ErrorMap>> : {
|
|
27
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
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
|
|
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> ? Procedure<MergedInitialContext<TInitialContext, TInjectedContext, $InitialContext>, $CurrentContext, $InputSchema, $OutputSchema, MergedErrorMap<TErrorMap, $ErrorMap>> : {
|
|
30
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
31
|
};
|
|
32
|
-
interface AugmentRouterOptions<TErrorMap extends ErrorMap> extends AugmentContractRouterOptions<TErrorMap
|
|
32
|
+
interface AugmentRouterOptions<TErrorMap extends ErrorMap> extends AugmentContractRouterOptions<TErrorMap>, ProcedureConfig {
|
|
33
33
|
middlewares: AnyMiddleware[];
|
|
34
34
|
}
|
|
35
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 {
|
|
36
|
+
interface AugmentImplementedRouterOptions extends ProcedureConfig {
|
|
37
37
|
middlewares: AnyMiddleware[];
|
|
38
38
|
}
|
|
39
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>;
|
|
@@ -47,72 +47,345 @@ declare function walkProcedureContractsAsync(router: RouterContract | AnyRouter,
|
|
|
47
47
|
type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
|
|
48
48
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? UnlaziedRouter<U> : never;
|
|
49
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* Fully resolves all lazy routers inside a router, returning a plain router.
|
|
52
|
+
* Useful for making a router with lazy parts contract-compatible.
|
|
53
|
+
*
|
|
54
|
+
* @see {@link https://orpc.dev/docs/contract/router#router-to-contract | Router Contract - Router to Contract}
|
|
55
|
+
*/
|
|
50
56
|
declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
|
|
51
57
|
|
|
58
|
+
/**
|
|
59
|
+
* The builder variant returned after `.use` is called.
|
|
60
|
+
* `.$context` and `.$config` are no longer available once middleware is applied.
|
|
61
|
+
*
|
|
62
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
63
|
+
*/
|
|
52
64
|
interface BuilderWithMiddlewares<TInitialContext extends Context, TInjectedContext extends Context, TErrorMap extends ErrorMap> {
|
|
53
65
|
'~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
|
|
66
|
+
/**
|
|
67
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
68
|
+
*
|
|
69
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
70
|
+
*/
|
|
54
71
|
'meta'(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithMiddlewares<TInitialContext, TInjectedContext, TErrorMap>;
|
|
72
|
+
/**
|
|
73
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
74
|
+
* via the `errors` utility in handlers and middleware.
|
|
75
|
+
*
|
|
76
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
77
|
+
*/
|
|
55
78
|
'errors'<T extends ErrorMap>(errors: T): BuilderWithMiddlewares<TInitialContext, TInjectedContext, MergedErrorMap<TErrorMap, T>>;
|
|
79
|
+
/**
|
|
80
|
+
* Applies a middleware that runs before the handler of every procedure
|
|
81
|
+
* built from this builder.
|
|
82
|
+
*
|
|
83
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
84
|
+
*/
|
|
56
85
|
'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>>;
|
|
86
|
+
/**
|
|
87
|
+
* Creates a standalone middleware that can be composed and applied to any
|
|
88
|
+
* compatible builder or procedure with `.use`.
|
|
89
|
+
*
|
|
90
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
91
|
+
*/
|
|
57
92
|
'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>;
|
|
93
|
+
/**
|
|
94
|
+
* Defines the input schema used to validate and type the procedure input.
|
|
95
|
+
*
|
|
96
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
97
|
+
*/
|
|
58
98
|
'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, T, TErrorMap>;
|
|
99
|
+
/**
|
|
100
|
+
* Defines the output schema used to validate and type the procedure output.
|
|
101
|
+
*
|
|
102
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
103
|
+
*/
|
|
59
104
|
'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, T, TErrorMap>;
|
|
60
|
-
|
|
105
|
+
/**
|
|
106
|
+
* Defines the function that implements the procedure and completes the
|
|
107
|
+
* chain, returning a callable procedure.
|
|
108
|
+
*
|
|
109
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
110
|
+
*/
|
|
111
|
+
'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, Schema<T>, TErrorMap>;
|
|
112
|
+
/**
|
|
113
|
+
* Applies the builder's middleware, errors, and metadata to every procedure
|
|
114
|
+
* in the given router.
|
|
115
|
+
*
|
|
116
|
+
* @see {@link https://orpc.dev/docs/router#extending-router | Router - Extending Router}
|
|
117
|
+
*/
|
|
61
118
|
'router'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(router: T): AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>;
|
|
119
|
+
/**
|
|
120
|
+
* Like `.router`, but loads the router lazily on first access, which helps
|
|
121
|
+
* reduce startup time for large applications.
|
|
122
|
+
*
|
|
123
|
+
* @see {@link https://orpc.dev/docs/router#lazy-router | Router - Lazy Router}
|
|
124
|
+
*/
|
|
62
125
|
'lazy'<T extends Router<MergedContext<TInitialContext, TInjectedContext>>>(loader: () => Promise<{
|
|
63
126
|
default: T;
|
|
64
127
|
}>): Lazy<AugmentedRouterWithMiddlewares<T, TInitialContext, TInjectedContext, TErrorMap>>;
|
|
65
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* The builder variant returned after `.input` is called.
|
|
131
|
+
* Only procedure-level methods remain available once an input schema is defined.
|
|
132
|
+
*
|
|
133
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
134
|
+
*/
|
|
66
135
|
interface BuilderWithInput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
67
136
|
'~orpc': BuilderDefinition<TInputSchema, InitialOutputSchema, TErrorMap>;
|
|
137
|
+
/**
|
|
138
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
139
|
+
*
|
|
140
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
141
|
+
*/
|
|
68
142
|
'meta'(...plugins: MetaPlugin<TInputSchema, InitialOutputSchema, TErrorMap>[]): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, TErrorMap>;
|
|
143
|
+
/**
|
|
144
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
145
|
+
* via the `errors` utility in handlers and middleware.
|
|
146
|
+
*
|
|
147
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
148
|
+
*/
|
|
69
149
|
'errors'<T extends ErrorMap>(errors: T): BuilderWithInput<TInitialContext, TInjectedContext, TInputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
150
|
+
/**
|
|
151
|
+
* Applies a middleware that runs before the handler and can access the
|
|
152
|
+
* validated input.
|
|
153
|
+
*
|
|
154
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
155
|
+
*/
|
|
70
156
|
'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>>;
|
|
157
|
+
/**
|
|
158
|
+
* Adds an additional input schema, merged with the previously defined one.
|
|
159
|
+
*
|
|
160
|
+
* @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
|
|
161
|
+
*/
|
|
71
162
|
'input'<T extends AnySchema>(schema: T): BuilderWithInput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TErrorMap>;
|
|
163
|
+
/**
|
|
164
|
+
* Defines the output schema used to validate and type the procedure output.
|
|
165
|
+
*
|
|
166
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
167
|
+
*/
|
|
72
168
|
'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, T, TErrorMap>;
|
|
73
|
-
|
|
169
|
+
/**
|
|
170
|
+
* Defines the function that implements the procedure and completes the
|
|
171
|
+
* chain, returning a callable procedure.
|
|
172
|
+
*
|
|
173
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
174
|
+
*/
|
|
175
|
+
'handler'<T>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, Schema<T>, TErrorMap>;
|
|
74
176
|
}
|
|
177
|
+
/**
|
|
178
|
+
* The builder variant returned after `.output` is called.
|
|
179
|
+
* Only procedure-level methods remain available once an output schema is defined.
|
|
180
|
+
*
|
|
181
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
182
|
+
*/
|
|
75
183
|
interface BuilderWithOutput<TInitialContext extends Context, TInjectedContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
76
184
|
'~orpc': BuilderDefinition<InitialInputSchema, TOutputSchema, TErrorMap>;
|
|
185
|
+
/**
|
|
186
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
187
|
+
*
|
|
188
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
189
|
+
*/
|
|
77
190
|
'meta'(...plugins: MetaPlugin<InitialInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, TErrorMap>;
|
|
191
|
+
/**
|
|
192
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
193
|
+
* via the `errors` utility in handlers and middleware.
|
|
194
|
+
*
|
|
195
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
196
|
+
*/
|
|
78
197
|
'errors'<T extends ErrorMap>(errors: T): BuilderWithOutput<TInitialContext, TInjectedContext, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
198
|
+
/**
|
|
199
|
+
* Applies a middleware that runs before the handler and can access the
|
|
200
|
+
* typed output.
|
|
201
|
+
*
|
|
202
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
203
|
+
*/
|
|
79
204
|
'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>>;
|
|
205
|
+
/**
|
|
206
|
+
* Defines the input schema used to validate and type the procedure input.
|
|
207
|
+
*
|
|
208
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
209
|
+
*/
|
|
80
210
|
'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, T, TOutputSchema, TErrorMap>;
|
|
211
|
+
/**
|
|
212
|
+
* Adds an additional output schema, merged with the previously defined one.
|
|
213
|
+
*
|
|
214
|
+
* @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
|
|
215
|
+
*/
|
|
81
216
|
'output'<T extends AnySchema>(schema: T): BuilderWithOutput<TInitialContext, TInjectedContext, MergedSchema<T, TOutputSchema>, TErrorMap>;
|
|
82
|
-
|
|
217
|
+
/**
|
|
218
|
+
* Defines the function that implements the procedure and completes the
|
|
219
|
+
* chain, returning a callable procedure.
|
|
220
|
+
*
|
|
221
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
222
|
+
*/
|
|
223
|
+
'handler'<T extends InferSchemaInput<TOutputSchema>>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, InitialInputSchema, TOutputSchema, TErrorMap>;
|
|
83
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
* The builder variant returned after both `.input` and `.output` are called.
|
|
227
|
+
* Only procedure-level methods remain available.
|
|
228
|
+
*
|
|
229
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
230
|
+
*/
|
|
84
231
|
interface BuilderWithInputOutput<TInitialContext extends Context, TInjectedContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> {
|
|
85
232
|
'~orpc': BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>;
|
|
233
|
+
/**
|
|
234
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
235
|
+
*
|
|
236
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
237
|
+
*/
|
|
86
238
|
'meta'(...plugins: MetaPlugin<TInputSchema, TOutputSchema, TErrorMap>[]): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
239
|
+
/**
|
|
240
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
241
|
+
* via the `errors` utility in handlers and middleware.
|
|
242
|
+
*
|
|
243
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
244
|
+
*/
|
|
87
245
|
'errors'<T extends ErrorMap>(errors: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, T>>;
|
|
246
|
+
/**
|
|
247
|
+
* Applies a middleware that runs before the handler and can access the
|
|
248
|
+
* validated input and typed output.
|
|
249
|
+
*
|
|
250
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
251
|
+
*/
|
|
88
252
|
'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>>;
|
|
253
|
+
/**
|
|
254
|
+
* Adds an additional input schema, merged with the previously defined one.
|
|
255
|
+
*
|
|
256
|
+
* @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
|
|
257
|
+
*/
|
|
89
258
|
'input'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, MergedSchema<T, TInputSchema>, TOutputSchema, TErrorMap>;
|
|
259
|
+
/**
|
|
260
|
+
* Adds an additional output schema, merged with the previously defined one.
|
|
261
|
+
*
|
|
262
|
+
* @see {@link https://orpc.dev/docs/procedure#multiple-schemas | Procedure - Multiple Schemas}
|
|
263
|
+
*/
|
|
90
264
|
'output'<T extends AnySchema>(schema: T): BuilderWithInputOutput<TInitialContext, TInjectedContext, TInputSchema, MergedSchema<T, TOutputSchema>, TErrorMap>;
|
|
91
|
-
|
|
265
|
+
/**
|
|
266
|
+
* Defines the function that implements the procedure and completes the
|
|
267
|
+
* chain, returning a callable procedure.
|
|
268
|
+
*
|
|
269
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
270
|
+
*/
|
|
271
|
+
'handler'<T extends InferSchemaInput<TOutputSchema>>(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
92
272
|
}
|
|
93
273
|
|
|
274
|
+
/**
|
|
275
|
+
* The initial context type used when `.$context` is not called.
|
|
276
|
+
* Augment this interface with `declare module '@orpc/server'` to define
|
|
277
|
+
* a default initial context type globally.
|
|
278
|
+
*
|
|
279
|
+
* @see {@link https://orpc.dev/docs/context#default-initial-context | Context - Default Initial Context}
|
|
280
|
+
*/
|
|
94
281
|
interface DefaultInitialContext {
|
|
95
282
|
}
|
|
96
|
-
interface BuilderDefinition<TInputSchema extends AnySchema, TInjectedContext extends AnySchema, TErrorMap extends ErrorMap> extends ProcedureContractDefinition<TInputSchema, TInjectedContext, TErrorMap
|
|
283
|
+
interface BuilderDefinition<TInputSchema extends AnySchema, TInjectedContext extends AnySchema, TErrorMap extends ErrorMap> extends ProcedureContractDefinition<TInputSchema, TInjectedContext, TErrorMap>, ProcedureConfig {
|
|
97
284
|
orderedMiddlewares: OrderedMiddleware[];
|
|
98
285
|
}
|
|
286
|
+
/**
|
|
287
|
+
* The procedure builder behind `os`. Chain its methods to gradually define
|
|
288
|
+
* context, middleware, errors, schemas, and finally a handler or router.
|
|
289
|
+
*
|
|
290
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
291
|
+
*/
|
|
99
292
|
declare class Builder<TInitialContext extends Context, TErrorMap extends ErrorMap> {
|
|
100
293
|
'~orpc': BuilderDefinition<InitialInputSchema, InitialOutputSchema, TErrorMap>;
|
|
294
|
+
/**
|
|
295
|
+
* Private constructor to prevent direct instantiation.
|
|
296
|
+
* Use the static `create` method to initialize a new instance with a safe initial definition.
|
|
297
|
+
*/
|
|
101
298
|
private constructor();
|
|
299
|
+
/**
|
|
300
|
+
* Creates a fresh builder with an empty definition.
|
|
301
|
+
* Prefer the exported `os` instance over calling this directly.
|
|
302
|
+
*
|
|
303
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
304
|
+
*/
|
|
102
305
|
static create<T extends Context = DefaultInitialContext>(): Builder<T & object, Record<never, never>>;
|
|
306
|
+
/**
|
|
307
|
+
* Declares the initial context type that must be provided when executing
|
|
308
|
+
* procedures built from this builder.
|
|
309
|
+
*
|
|
310
|
+
* @see {@link https://orpc.dev/docs/context#initial-context | Context - Initial Context}
|
|
311
|
+
*/
|
|
103
312
|
$context<T extends Context = DefaultInitialContext>(): Builder<T & object, TErrorMap>;
|
|
313
|
+
/**
|
|
314
|
+
* Overrides the procedure configuration, such as disabling runtime
|
|
315
|
+
* input/output validation.
|
|
316
|
+
*
|
|
317
|
+
* @see {@link https://orpc.dev/docs/recipes/validation-customization | Validation Customization}
|
|
318
|
+
*/
|
|
319
|
+
$config(config: ProcedureConfig): Builder<TInitialContext, TErrorMap>;
|
|
320
|
+
/**
|
|
321
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
322
|
+
*
|
|
323
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
324
|
+
*/
|
|
104
325
|
meta(...plugins: MetaPlugin<InitialInputSchema, InitialOutputSchema, TErrorMap>[]): Builder<TInitialContext, TErrorMap>;
|
|
326
|
+
/**
|
|
327
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
328
|
+
* via the `errors` utility in handlers and middleware.
|
|
329
|
+
*
|
|
330
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
331
|
+
*/
|
|
105
332
|
errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, MergedErrorMap<TErrorMap, U>>;
|
|
333
|
+
/**
|
|
334
|
+
* Applies a middleware that runs before the handler of every procedure
|
|
335
|
+
* built from this builder.
|
|
336
|
+
*
|
|
337
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
338
|
+
*/
|
|
106
339
|
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>>;
|
|
340
|
+
/**
|
|
341
|
+
* Creates a standalone middleware that can be composed and applied to any
|
|
342
|
+
* compatible builder or procedure with `.use`.
|
|
343
|
+
*
|
|
344
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
345
|
+
*/
|
|
107
346
|
middleware<$OutContext extends IntersectPick<TInitialContext, $OutContext>, $Input, $Output = any>(middleware: Middleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>): DecoratedMiddleware<TInitialContext, $OutContext, $Input, $Output, TErrorMap>;
|
|
347
|
+
/**
|
|
348
|
+
* Defines the input schema used to validate and type the procedure input.
|
|
349
|
+
*
|
|
350
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
351
|
+
*/
|
|
108
352
|
input<$ extends AnySchema>(schema: $): BuilderWithInput<TInitialContext, object, $, TErrorMap>;
|
|
353
|
+
/**
|
|
354
|
+
* Defines the output schema used to validate and type the procedure output.
|
|
355
|
+
*
|
|
356
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
357
|
+
*/
|
|
109
358
|
output<$ extends AnySchema>(schema: $): BuilderWithOutput<TInitialContext, object, $, TErrorMap>;
|
|
110
|
-
|
|
359
|
+
/**
|
|
360
|
+
* Defines the function that implements the procedure and completes the
|
|
361
|
+
* chain, returning a callable procedure.
|
|
362
|
+
*
|
|
363
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
364
|
+
*/
|
|
365
|
+
handler<T>(handler: ProcedureHandler<TInitialContext, InferSchemaOutput<InitialInputSchema>, T, ORPCErrorConstructorMap<TErrorMap>>): DecoratedProcedure<TInitialContext, object, InitialInputSchema, Schema<T>, TErrorMap>;
|
|
366
|
+
/**
|
|
367
|
+
* Applies the builder's middleware, errors, and metadata to every procedure
|
|
368
|
+
* in the given router.
|
|
369
|
+
*
|
|
370
|
+
* @see {@link https://orpc.dev/docs/router#extending-router | Router - Extending Router}
|
|
371
|
+
*/
|
|
111
372
|
router<T extends AnyRouter>(router: T): AugmentedRouter<T, TErrorMap>;
|
|
373
|
+
/**
|
|
374
|
+
* Like `.router`, but loads the router lazily on first access, which helps
|
|
375
|
+
* reduce startup time for large applications.
|
|
376
|
+
*
|
|
377
|
+
* @see {@link https://orpc.dev/docs/router#lazy-router | Router - Lazy Router}
|
|
378
|
+
*/
|
|
112
379
|
lazy<T extends AnyRouter>(loader: () => Promise<{
|
|
113
380
|
default: T;
|
|
114
381
|
}>): Lazy<AugmentedRouter<T, TErrorMap>>;
|
|
115
382
|
}
|
|
383
|
+
/**
|
|
384
|
+
* The oRPC procedure builder. Chain methods like `.input`, `.use`, and `.handler`
|
|
385
|
+
* to define procedures, then compose them into routers.
|
|
386
|
+
*
|
|
387
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
388
|
+
*/
|
|
116
389
|
declare const os: Builder<DefaultInitialContext & object, Record<never, never>>;
|
|
117
390
|
|
|
118
391
|
declare const DEFAULT_SUCCESS_STATUS = 200;
|
|
@@ -122,18 +395,19 @@ declare class ProcedureImplementer<TInitialContext extends Context, TInjectedCon
|
|
|
122
395
|
'~orpc': BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>;
|
|
123
396
|
constructor(definition: BuilderDefinition<TInputSchema, TOutputSchema, TErrorMap>);
|
|
124
397
|
'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>,
|
|
398
|
+
'handler'(handler: ProcedureHandler<MergedContext<TInitialContext, TInjectedContext>, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, ORPCErrorConstructorMap<TErrorMap>>): ImplementedProcedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
126
399
|
}
|
|
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
|
|
400
|
+
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> {
|
|
128
401
|
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>;
|
|
129
402
|
}
|
|
130
403
|
|
|
131
404
|
declare class SharedRouterImplementer<TContract extends RouterContract, TInitialContext extends Context> {
|
|
132
405
|
private readonly contract;
|
|
406
|
+
private readonly config;
|
|
133
407
|
private readonly middlewares;
|
|
134
408
|
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>;
|
|
409
|
+
static create<TContract extends RouterContract, TInitialContext extends Context>(contract: TContract, config: ProcedureConfig): SharedRouterImplementer<TContract, TInitialContext>;
|
|
410
|
+
static create<TContract extends RouterContract, TInitialContext extends Context, TInjectedContext extends Context>(contract: TContract, config: ProcedureConfig, middlewares: AnyMiddleware[]): SharedRouterImplementerWithMiddlewares<TContract, TInitialContext, TInjectedContext>;
|
|
137
411
|
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
412
|
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
413
|
router<T extends ContractedRouter<TContract, any>>(router: T): T;
|
|
@@ -155,12 +429,19 @@ type RouterImplementer<TContract extends RouterContract, TInitialContext extends
|
|
|
155
429
|
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
430
|
[K in keyof TContract]: TContract[K] extends RouterContract ? RouterImplementerWithMiddlewares<TContract[K], TInitialContext, TInjectedContext> : never;
|
|
157
431
|
};
|
|
158
|
-
declare function createRouterImplementer<TContract extends RouterContract, TInitialContext extends Context>(contract: TContract): RouterImplementer<TContract, TInitialContext>;
|
|
432
|
+
declare function createRouterImplementer<TContract extends RouterContract, TInitialContext extends Context>(contract: TContract, config: ProcedureConfig): RouterImplementer<TContract, TInitialContext>;
|
|
159
433
|
|
|
160
434
|
type Implementer<TContract extends RouterContract, TInitialContext extends Context> = {
|
|
161
435
|
$context<T extends Context = DefaultInitialContext>(): Implementer<TContract, T & object>;
|
|
436
|
+
$config(config: ProcedureConfig): Implementer<TContract, TInitialContext>;
|
|
162
437
|
} & RouterImplementer<TContract, TInitialContext>;
|
|
163
|
-
|
|
438
|
+
/**
|
|
439
|
+
* Turns a contract into an implementer, used to implement the contract's
|
|
440
|
+
* procedures, routers, and middleware with full type safety.
|
|
441
|
+
*
|
|
442
|
+
* @see {@link https://orpc.dev/docs/contract/implementation#implementer | Contract Implementation - Implementer}
|
|
443
|
+
*/
|
|
444
|
+
declare function implement<TContract extends RouterContract, TInitialContext extends Context = DefaultInitialContext>(contract: TContract, config?: ProcedureConfig): Implementer<TContract, TInitialContext & object>;
|
|
164
445
|
|
|
165
446
|
declare function createGuardedProcedureLazy(lazy: Lazy<unknown>): Lazy<AnyProcedure>;
|
|
166
447
|
/**
|
|
@@ -170,9 +451,9 @@ declare function createGuardedProcedureLazy(lazy: Lazy<unknown>): Lazy<AnyProced
|
|
|
170
451
|
* but .errors (in case implemented procedure error map is more than enough) and .meta cannot be
|
|
171
452
|
* validated that way - so they must be overridden here to ensure the client always sees what the contract defines.
|
|
172
453
|
*/
|
|
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
|
|
174
|
-
type CallOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap
|
|
175
|
-
type CallRest<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap
|
|
454
|
+
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>, contract: ProcedureContract<any, any, TErrorMap>): Procedure<TInitialContext, TInjectedContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
455
|
+
type CallOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = ProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, object> & Omit<ClientOptions<object>, 'context'>;
|
|
456
|
+
type CallRest<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = object extends CallOptions<TInitialContext, TOutputSchema, TErrorMap> ? undefined extends InferSchemaInput<TInputSchema> ? [input?: InferSchemaInput<TInputSchema>, options?: CallOptions<TInitialContext, TOutputSchema, TErrorMap>] : [input: InferSchemaInput<TInputSchema>, options?: CallOptions<TInitialContext, TOutputSchema, TErrorMap>] : [input: InferSchemaInput<TInputSchema>, options: CallOptions<TInitialContext, TOutputSchema, TErrorMap>];
|
|
176
457
|
/**
|
|
177
458
|
* Quickly call a procedure without creating a client.
|
|
178
459
|
*
|
|
@@ -181,16 +462,30 @@ type CallRest<TInitialContext extends Context, TInputSchema extends AnySchema, T
|
|
|
181
462
|
* const output = await call(getting, 'input')
|
|
182
463
|
* const output = await call(getting, 'input', { context: { db: 'postgres' } })
|
|
183
464
|
* ```
|
|
465
|
+
*
|
|
466
|
+
* @see {@link https://orpc.dev/docs/client/server-side#one-off-calls | Server-Side Clients - One-Off Calls}
|
|
184
467
|
*/
|
|
185
|
-
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap
|
|
468
|
+
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap>>, ...[input, options,]: CallRest<TInitialContext, TInputSchema, TOutputSchema, TErrorMap>): PromiseWithError<InferSchemaOutput<TOutputSchema>, ORPCErrorFromErrorMap<TErrorMap> | ThrowableError>;
|
|
186
469
|
|
|
187
|
-
|
|
470
|
+
/**
|
|
471
|
+
* The client type derived from a router, exposing every procedure as a callable
|
|
472
|
+
* function while preserving the router's shape.
|
|
473
|
+
*
|
|
474
|
+
* @see {@link https://orpc.dev/docs/client/client-side#creating-a-client | Client-Side Clients - Creating a Client}
|
|
475
|
+
*/
|
|
476
|
+
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = object> = TRouter extends Procedure<any, any, infer $InputSchema, infer $OutputSchema, infer $ErrorMap> ? ProcedureClient<TClientContext, $InputSchema, $OutputSchema, $ErrorMap> : {
|
|
188
477
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
|
189
478
|
};
|
|
190
|
-
|
|
479
|
+
/**
|
|
480
|
+
* Creates a server-side client that calls the router's procedures directly,
|
|
481
|
+
* within the same process, without any network layer.
|
|
482
|
+
*
|
|
483
|
+
* @see {@link https://orpc.dev/docs/client/server-side#router-clients | Server-Side Clients - Router Clients}
|
|
484
|
+
*/
|
|
485
|
+
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext = object>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<ProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown>, ErrorMap, TClientContext>>): RouterClient<T, TClientContext>;
|
|
191
486
|
|
|
192
487
|
declare function withHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: RouterContract): T;
|
|
193
488
|
declare function getHiddenRouterContract(router: Lazyable<AnyRouter | RouterContract>): RouterContract | undefined;
|
|
194
489
|
|
|
195
|
-
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, ContractedRouter, DEFAULT_ERROR_STATUS, DEFAULT_SUCCESS_STATUS, DecoratedProcedure, ImplementedProcedure, InferRouterInitialContext, Lazy, Lazyable, MergedContext, MergedInitialContext, Middleware,
|
|
490
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, ContractedRouter, DEFAULT_ERROR_STATUS, DEFAULT_SUCCESS_STATUS, DecoratedProcedure, ImplementedProcedure, InferRouterInitialContext, Lazy, Lazyable, MergedContext, MergedInitialContext, Middleware, OrderedMiddleware, Procedure, ProcedureClient, ProcedureClientOptions, ProcedureConfig, ProcedureHandler, ProcedureImplementer, Router, SharedRouterImplementer, augmentImplementedRouter, augmentRouter, call, createContractProcedure, createGuardedProcedureLazy, createRouterClient, createRouterImplementer, decorateMiddleware, getHiddenRouterContract, getRouter, implement, os, unlazyRouter, walkProcedureContractsAsync, walkProcedureContractsSync, withHiddenRouterContract };
|
|
196
491
|
export type { AugmentImplementedRouterOptions, AugmentRouterOptions, AugmentedRouter, AugmentedRouterWithMiddlewares, BuilderDefinition, BuilderWithInput, BuilderWithInputOutput, BuilderWithMiddlewares, BuilderWithOutput, CallOptions, CallRest, DecoratedMiddleware, DefaultInitialContext, Implementer, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, SharedRouterImplementerWithMiddlewares, UnlaziedRouter, WalkProcedureContractsLazyResult };
|