@temporary-name/server 1.9.3-alpha.03e17aa3340f4b261a549bf9e3fe948b084e2309
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/LICENSE +21 -0
- package/README.md +31 -0
- package/dist/adapters/aws-lambda/index.d.mts +30 -0
- package/dist/adapters/aws-lambda/index.d.ts +30 -0
- package/dist/adapters/aws-lambda/index.mjs +33 -0
- package/dist/adapters/fetch/index.d.mts +108 -0
- package/dist/adapters/fetch/index.d.ts +108 -0
- package/dist/adapters/fetch/index.mjs +174 -0
- package/dist/adapters/node/index.d.mts +83 -0
- package/dist/adapters/node/index.d.ts +83 -0
- package/dist/adapters/node/index.mjs +139 -0
- package/dist/adapters/standard/index.d.mts +42 -0
- package/dist/adapters/standard/index.d.ts +42 -0
- package/dist/adapters/standard/index.mjs +11 -0
- package/dist/helpers/index.d.mts +149 -0
- package/dist/helpers/index.d.ts +149 -0
- package/dist/helpers/index.mjs +168 -0
- package/dist/index.d.mts +603 -0
- package/dist/index.d.ts +603 -0
- package/dist/index.mjs +617 -0
- package/dist/openapi/index.d.mts +220 -0
- package/dist/openapi/index.d.ts +220 -0
- package/dist/openapi/index.mjs +776 -0
- package/dist/plugins/index.d.mts +160 -0
- package/dist/plugins/index.d.ts +160 -0
- package/dist/plugins/index.mjs +288 -0
- package/dist/shared/server.BEHw7Eyx.mjs +247 -0
- package/dist/shared/server.BKSOrA6h.d.mts +192 -0
- package/dist/shared/server.BKSOrA6h.d.ts +192 -0
- package/dist/shared/server.BKh8I1Ny.mjs +239 -0
- package/dist/shared/server.BeuTpcmO.d.mts +23 -0
- package/dist/shared/server.C1fnTLq0.d.mts +57 -0
- package/dist/shared/server.CQyYNJ1H.d.ts +57 -0
- package/dist/shared/server.DLsti1Pv.mjs +293 -0
- package/dist/shared/server.SLLuK6_v.d.ts +23 -0
- package/package.json +95 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,603 @@
|
|
|
1
|
+
import { AnySchema, ErrorMap, Meta, MergedErrorMap, Route, InferSchemaOutput, InferSchemaInput, EnhanceRouteOptions, AnyContractRouter, AnyContractProcedure, Schema, ContractRouter, ContractProcedureDef, ContractProcedure, InferContractRouterErrorMap, InferContractRouterMeta, ErrorFromErrorMap } from '@temporary-name/contract';
|
|
2
|
+
export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type, validateORPCError } from '@temporary-name/contract';
|
|
3
|
+
import { IntersectPick, ClientContext, MaybeOptionalOptions, HTTPPath, ClientOptions, ClientPromiseResult } from '@temporary-name/shared';
|
|
4
|
+
export { AsyncIteratorClass, ClientContext, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, HTTPMethod, HTTPPath, IntersectPick, ORPCError, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, safe, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
|
|
5
|
+
import { C as Context, P as Procedure, M as Middleware, O as ORPCErrorConstructorMap, a as MergedInitialContext, b as MergedCurrentContext, c as MapInputMiddleware, d as CreateProcedureClientOptions, e as ProcedureClient, A as AnyMiddleware, L as Lazyable, f as AnyRouter, g as Lazy, h as AnyProcedure, i as ProcedureHandler, R as Router, I as InferRouterInitialContext } from './shared/server.BKSOrA6h.js';
|
|
6
|
+
export { H as InferRouterCurrentContexts, G as InferRouterInitialContexts, J as InferRouterInputs, K as InferRouterOutputs, n as LAZY_SYMBOL, o as LazyMeta, v as MiddlewareNextFn, t as MiddlewareNextFnOptions, x as MiddlewareOptions, w as MiddlewareOutputFn, s as MiddlewareResult, k as ORPCErrorConstructorMapItem, j as ORPCErrorConstructorMapItemOptions, E as ProcedureClientInterceptorOptions, B as ProcedureDef, z as ProcedureHandlerOptions, l as createORPCErrorConstructorMap, F as createProcedureClient, r as getLazyMeta, q as isLazy, D as isProcedure, p as lazy, m as mergeCurrentContext, y as middlewareOutputFn, u as unlazy } from './shared/server.BKSOrA6h.js';
|
|
7
|
+
export { getEventMeta, withEventMeta } from '@temporary-name/standard-server';
|
|
8
|
+
|
|
9
|
+
declare class DecoratedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
10
|
+
/**
|
|
11
|
+
* Adds type-safe custom errors.
|
|
12
|
+
* The provided errors are spared-merged with any existing errors.
|
|
13
|
+
*
|
|
14
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
15
|
+
*/
|
|
16
|
+
errors<U extends ErrorMap>(errors: U): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
17
|
+
/**
|
|
18
|
+
* Sets or updates the metadata.
|
|
19
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
20
|
+
*
|
|
21
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
22
|
+
*/
|
|
23
|
+
meta(meta: TMeta): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
24
|
+
/**
|
|
25
|
+
* Sets or updates the route definition.
|
|
26
|
+
* The provided route is spared-merged with any existing route.
|
|
27
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
28
|
+
*
|
|
29
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
30
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
31
|
+
*/
|
|
32
|
+
route(route: Route): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
33
|
+
/**
|
|
34
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
35
|
+
*
|
|
36
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
37
|
+
* @info Pass second argument to map the input.
|
|
38
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
40
|
+
*/
|
|
41
|
+
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>;
|
|
42
|
+
/**
|
|
43
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
44
|
+
*
|
|
45
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
46
|
+
* @info Pass second argument to map the input.
|
|
47
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
48
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
49
|
+
*/
|
|
50
|
+
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>;
|
|
51
|
+
/**
|
|
52
|
+
* Make this procedure callable (works like a function while still being a procedure).
|
|
53
|
+
*
|
|
54
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
55
|
+
*/
|
|
56
|
+
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
declare function getRouter<T extends Lazyable<AnyRouter | undefined>>(router: T, path: readonly string[]): T extends Lazy<any> ? Lazy<AnyRouter | undefined> : Lazyable<AnyRouter | undefined>;
|
|
60
|
+
type AccessibleLazyRouter<T extends Lazyable<AnyRouter | undefined>> = T extends Lazy<infer U extends AnyRouter | undefined | Lazy<AnyRouter | undefined>> ? AccessibleLazyRouter<U> : T extends AnyProcedure | undefined ? Lazy<T> : Lazy<T> & {
|
|
61
|
+
[K in keyof T]: T[K] extends Lazyable<AnyRouter> ? AccessibleLazyRouter<T[K]> : never;
|
|
62
|
+
};
|
|
63
|
+
declare function createAccessibleLazyRouter<T extends Lazy<AnyRouter | undefined>>(lazied: T): AccessibleLazyRouter<T>;
|
|
64
|
+
type EnhancedRouter<T extends Lazyable<AnyRouter>, TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap> = T extends Lazy<infer U extends AnyRouter> ? AccessibleLazyRouter<EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>> : T extends (Procedure<infer UInitialContext, infer UCurrentContext, infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta>) ? Procedure<MergedInitialContext<TInitialContext, UInitialContext, TCurrentContext>, UCurrentContext, UInputSchema, UOutputSchema, MergedErrorMap<TErrorMap, UErrorMap>, UMeta> : {
|
|
65
|
+
[K in keyof T]: T[K] extends Lazyable<AnyRouter> ? EnhancedRouter<T[K], TInitialContext, TCurrentContext, TErrorMap> : never;
|
|
66
|
+
};
|
|
67
|
+
interface EnhanceRouterOptions<TErrorMap extends ErrorMap> extends EnhanceRouteOptions {
|
|
68
|
+
middlewares: readonly AnyMiddleware[];
|
|
69
|
+
errorMap: TErrorMap;
|
|
70
|
+
dedupeLeadingMiddlewares: boolean;
|
|
71
|
+
}
|
|
72
|
+
declare function enhanceRouter<T extends Lazyable<AnyRouter>, TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap>(router: T, options: EnhanceRouterOptions<TErrorMap>): EnhancedRouter<T, TInitialContext, TCurrentContext, TErrorMap>;
|
|
73
|
+
interface TraverseContractProceduresOptions {
|
|
74
|
+
router: AnyContractRouter | AnyRouter;
|
|
75
|
+
path: readonly string[];
|
|
76
|
+
}
|
|
77
|
+
interface TraverseContractProcedureCallbackOptions {
|
|
78
|
+
contract: AnyContractProcedure | AnyProcedure;
|
|
79
|
+
path: readonly string[];
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @deprecated Use `TraverseContractProcedureCallbackOptions` instead.
|
|
83
|
+
*/
|
|
84
|
+
type ContractProcedureCallbackOptions = TraverseContractProcedureCallbackOptions;
|
|
85
|
+
interface LazyTraverseContractProceduresOptions {
|
|
86
|
+
router: Lazy<AnyRouter>;
|
|
87
|
+
path: readonly string[];
|
|
88
|
+
}
|
|
89
|
+
declare function traverseContractProcedures(options: TraverseContractProceduresOptions, callback: (options: TraverseContractProcedureCallbackOptions) => void, lazyOptions?: LazyTraverseContractProceduresOptions[]): LazyTraverseContractProceduresOptions[];
|
|
90
|
+
declare function resolveContractProcedures(options: TraverseContractProceduresOptions, callback: (options: TraverseContractProcedureCallbackOptions) => void): Promise<void>;
|
|
91
|
+
type UnlaziedRouter<T extends AnyRouter> = T extends AnyProcedure ? T : {
|
|
92
|
+
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? UnlaziedRouter<U> : never;
|
|
93
|
+
};
|
|
94
|
+
declare function unlazyRouter<T extends AnyRouter>(router: T): Promise<UnlaziedRouter<T>>;
|
|
95
|
+
|
|
96
|
+
interface BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TGateName extends string> {
|
|
97
|
+
/**
|
|
98
|
+
* This property holds the defined options.
|
|
99
|
+
*/
|
|
100
|
+
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
101
|
+
/**
|
|
102
|
+
* Adds type-safe custom errors.
|
|
103
|
+
* The provided errors are spared-merged with any existing errors.
|
|
104
|
+
*
|
|
105
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
106
|
+
*/
|
|
107
|
+
'errors'<U extends ErrorMap>(errors: U): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta, TGateName>;
|
|
108
|
+
/**
|
|
109
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
110
|
+
*
|
|
111
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
112
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
114
|
+
*/
|
|
115
|
+
'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, TGateName>;
|
|
116
|
+
/**
|
|
117
|
+
* Sets or updates the metadata.
|
|
118
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
119
|
+
*
|
|
120
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
121
|
+
*/
|
|
122
|
+
'meta'(meta: TMeta): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
123
|
+
/**
|
|
124
|
+
* Sets or updates the route definition.
|
|
125
|
+
* The provided route is spared-merged with any existing route.
|
|
126
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
127
|
+
*
|
|
128
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
129
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
130
|
+
*/
|
|
131
|
+
'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
132
|
+
/**
|
|
133
|
+
* Defines the input validation schema.
|
|
134
|
+
*
|
|
135
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
136
|
+
*/
|
|
137
|
+
'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
138
|
+
/**
|
|
139
|
+
* Defines the output validation schema.
|
|
140
|
+
*
|
|
141
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
142
|
+
*/
|
|
143
|
+
'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta, TGateName>;
|
|
144
|
+
/**
|
|
145
|
+
* Defines the handler of the procedure.
|
|
146
|
+
*
|
|
147
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
148
|
+
*/
|
|
149
|
+
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
150
|
+
/**
|
|
151
|
+
* Prefixes all procedures in the router.
|
|
152
|
+
* The provided prefix is post-appended to any existing router prefix.
|
|
153
|
+
*
|
|
154
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
155
|
+
*
|
|
156
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
157
|
+
*/
|
|
158
|
+
'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
159
|
+
/**
|
|
160
|
+
* Adds tags to all procedures in the router.
|
|
161
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
162
|
+
*
|
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
164
|
+
*/
|
|
165
|
+
'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
166
|
+
/**
|
|
167
|
+
* Applies all of the previously defined options to the specified router.
|
|
168
|
+
*
|
|
169
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
170
|
+
*/
|
|
171
|
+
'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
172
|
+
/**
|
|
173
|
+
* Create a lazy router
|
|
174
|
+
* And applies all of the previously defined options to the specified router.
|
|
175
|
+
*
|
|
176
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
177
|
+
*/
|
|
178
|
+
'lazyRoute'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
179
|
+
default: U;
|
|
180
|
+
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
181
|
+
}
|
|
182
|
+
interface ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TGateName extends string> {
|
|
183
|
+
/**
|
|
184
|
+
* This property holds the defined options.
|
|
185
|
+
*/
|
|
186
|
+
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
187
|
+
/**
|
|
188
|
+
* Adds type-safe custom errors.
|
|
189
|
+
* The provided errors are spared-merged with any existing errors.
|
|
190
|
+
*
|
|
191
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
192
|
+
*/
|
|
193
|
+
'errors'<U extends ErrorMap>(errors: U): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta, TGateName>;
|
|
194
|
+
/**
|
|
195
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
196
|
+
*
|
|
197
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
198
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
199
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
200
|
+
*/
|
|
201
|
+
'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, TGateName>;
|
|
202
|
+
/**
|
|
203
|
+
* Sets or updates the metadata.
|
|
204
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
205
|
+
*
|
|
206
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
207
|
+
*/
|
|
208
|
+
'meta'(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
209
|
+
/**
|
|
210
|
+
* Sets or updates the route definition.
|
|
211
|
+
* The provided route is spared-merged with any existing route.
|
|
212
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
213
|
+
*
|
|
214
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
215
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
216
|
+
*/
|
|
217
|
+
'route'(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
218
|
+
/**
|
|
219
|
+
* Defines the input validation schema.
|
|
220
|
+
*
|
|
221
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
222
|
+
*/
|
|
223
|
+
'input'<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
224
|
+
/**
|
|
225
|
+
* Defines the output validation schema.
|
|
226
|
+
*
|
|
227
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
228
|
+
*/
|
|
229
|
+
'output'<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta, TGateName>;
|
|
230
|
+
/**
|
|
231
|
+
* Defines the handler of the procedure.
|
|
232
|
+
*
|
|
233
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
234
|
+
*/
|
|
235
|
+
'handler'<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
236
|
+
}
|
|
237
|
+
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
238
|
+
/**
|
|
239
|
+
* This property holds the defined options.
|
|
240
|
+
*/
|
|
241
|
+
'~orpc': EnhanceRouterOptions<TErrorMap>;
|
|
242
|
+
/**
|
|
243
|
+
* Adds type-safe custom errors.
|
|
244
|
+
* The provided errors are spared-merged with any existing errors.
|
|
245
|
+
*
|
|
246
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
247
|
+
*/
|
|
248
|
+
'errors'<U extends ErrorMap>(errors: U): RouterBuilder<TInitialContext, TCurrentContext, MergedErrorMap<TErrorMap, U>, TMeta>;
|
|
249
|
+
/**
|
|
250
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
251
|
+
*
|
|
252
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
253
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
254
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
255
|
+
*/
|
|
256
|
+
'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>;
|
|
257
|
+
/**
|
|
258
|
+
* Prefixes all procedures in the router.
|
|
259
|
+
* The provided prefix is post-appended to any existing router prefix.
|
|
260
|
+
*
|
|
261
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
262
|
+
*
|
|
263
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
264
|
+
*/
|
|
265
|
+
'prefix'(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
266
|
+
/**
|
|
267
|
+
* Adds tags to all procedures in the router.
|
|
268
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
269
|
+
*
|
|
270
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
271
|
+
*/
|
|
272
|
+
'tag'(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
273
|
+
/**
|
|
274
|
+
* Applies all of the previously defined options to the specified router.
|
|
275
|
+
*
|
|
276
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
277
|
+
*/
|
|
278
|
+
'router'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
279
|
+
/**
|
|
280
|
+
* Create a lazy router
|
|
281
|
+
* And applies all of the previously defined options to the specified router.
|
|
282
|
+
*
|
|
283
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
284
|
+
*/
|
|
285
|
+
'lazyRoute'<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
286
|
+
default: U;
|
|
287
|
+
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> extends Middleware<TInContext, TOutContext, TInput, TOutput, TErrorConstructorMap, TMeta> {
|
|
291
|
+
/**
|
|
292
|
+
* Change the expected input type by providing a map function.
|
|
293
|
+
*/
|
|
294
|
+
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput, TErrorConstructorMap, TMeta>;
|
|
295
|
+
/**
|
|
296
|
+
* Concatenates two middlewares.
|
|
297
|
+
*
|
|
298
|
+
* @info Pass second argument to map the input.
|
|
299
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
300
|
+
*/
|
|
301
|
+
concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UInput extends TInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, UInput, TOutput, TErrorConstructorMap, TMeta>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TErrorConstructorMap, TMeta>;
|
|
302
|
+
/**
|
|
303
|
+
* Concatenates two middlewares.
|
|
304
|
+
*
|
|
305
|
+
* @info Pass second argument to map the input.
|
|
306
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
307
|
+
*/
|
|
308
|
+
concat<UOutContext extends IntersectPick<MergedCurrentContext<TInContext, TOutContext>, UOutContext>, UInput extends TInput, UMappedInput, UInContext extends Context = MergedCurrentContext<TInContext, TOutContext>>(middleware: Middleware<UInContext | MergedCurrentContext<TInContext, TOutContext>, UOutContext, UMappedInput, TOutput, TErrorConstructorMap, TMeta>, mapInput: MapInputMiddleware<UInput, UMappedInput>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TErrorConstructorMap, TMeta>;
|
|
309
|
+
}
|
|
310
|
+
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>;
|
|
311
|
+
|
|
312
|
+
interface BuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TGateName extends string> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceRouterOptions<TErrorMap> {
|
|
313
|
+
middlewares: readonly AnyMiddleware[];
|
|
314
|
+
inputValidationIndex: number;
|
|
315
|
+
outputValidationIndex: number;
|
|
316
|
+
}
|
|
317
|
+
declare class Builder<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TGateName extends string> {
|
|
318
|
+
/**
|
|
319
|
+
* This property holds the defined options.
|
|
320
|
+
*/
|
|
321
|
+
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
322
|
+
constructor(def: BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>);
|
|
323
|
+
/**
|
|
324
|
+
* Set or override the initial context.
|
|
325
|
+
*
|
|
326
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
327
|
+
*/
|
|
328
|
+
$context<U extends Context>(): Builder<U & Record<never, never>, U, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
329
|
+
/**
|
|
330
|
+
* Creates a middleware.
|
|
331
|
+
*
|
|
332
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
333
|
+
*/
|
|
334
|
+
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
335
|
+
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<TErrorMap>, TMeta>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, TMeta>;
|
|
336
|
+
/**
|
|
337
|
+
* Adds type-safe custom errors.
|
|
338
|
+
* The provided errors are spared-merged with any existing errors.
|
|
339
|
+
*
|
|
340
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
341
|
+
*/
|
|
342
|
+
errors<U extends ErrorMap>(errors: U): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta, TGateName>;
|
|
343
|
+
/**
|
|
344
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
345
|
+
*
|
|
346
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
347
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
348
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
349
|
+
*/
|
|
350
|
+
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, TGateName>;
|
|
351
|
+
useGating<const TInferredGateName extends string>(gates: TInferredGateName[], isGateEnabled: (gate: TInferredGateName, ctx: TCurrentContext) => boolean): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, Context, TCurrentContext>, MergedCurrentContext<TCurrentContext, {
|
|
352
|
+
isGateEnabled: typeof isGateEnabled;
|
|
353
|
+
}>, TInputSchema, TOutputSchema, TErrorMap, TMeta, TInferredGateName>;
|
|
354
|
+
/**
|
|
355
|
+
* Sets or updates the metadata.
|
|
356
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
357
|
+
*
|
|
358
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
359
|
+
*/
|
|
360
|
+
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
361
|
+
/**
|
|
362
|
+
* Sets or updates the route definition.
|
|
363
|
+
* The provided route is spared-merged with any existing route.
|
|
364
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
365
|
+
*
|
|
366
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
367
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
368
|
+
*/
|
|
369
|
+
route(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
370
|
+
/**
|
|
371
|
+
* Defines the input validation schema.
|
|
372
|
+
*
|
|
373
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
374
|
+
*/
|
|
375
|
+
input<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, USchema, TOutputSchema, TErrorMap, TMeta, TGateName>;
|
|
376
|
+
/**
|
|
377
|
+
* Defines the output validation schema.
|
|
378
|
+
*
|
|
379
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
380
|
+
*/
|
|
381
|
+
output<USchema extends AnySchema>(schema: USchema): ProcedureBuilder<TInitialContext, TCurrentContext, TInputSchema, USchema, TErrorMap, TMeta, TGateName>;
|
|
382
|
+
/**
|
|
383
|
+
* Defines the handler of the procedure.
|
|
384
|
+
*
|
|
385
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
386
|
+
*/
|
|
387
|
+
handler<UFuncOutput>(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, UFuncOutput, TErrorMap, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TInputSchema, Schema<UFuncOutput, UFuncOutput>, TErrorMap, TMeta>;
|
|
388
|
+
/**
|
|
389
|
+
* Prefixes all procedures in the router.
|
|
390
|
+
* The provided prefix is post-appended to any existing router prefix.
|
|
391
|
+
*
|
|
392
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
393
|
+
*
|
|
394
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
395
|
+
*/
|
|
396
|
+
prefix(prefix: HTTPPath): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
397
|
+
/**
|
|
398
|
+
* Adds tags to all procedures in the router.
|
|
399
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
400
|
+
*
|
|
401
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
402
|
+
*/
|
|
403
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TErrorMap, TMeta>;
|
|
404
|
+
/**
|
|
405
|
+
* Applies all of the previously defined options to the specified router.
|
|
406
|
+
*
|
|
407
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
408
|
+
*/
|
|
409
|
+
router<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, TErrorMap>;
|
|
410
|
+
/**
|
|
411
|
+
* Create a lazy router
|
|
412
|
+
* And applies all of the previously defined options to the specified router.
|
|
413
|
+
*
|
|
414
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
415
|
+
*/
|
|
416
|
+
lazyRoute<U extends Router<ContractRouter<TMeta>, TCurrentContext>>(loader: () => Promise<{
|
|
417
|
+
default: U;
|
|
418
|
+
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, TErrorMap>;
|
|
419
|
+
}
|
|
420
|
+
type ApiBuilder<TMeta extends Meta> = Builder<Record<never, never>, Record<never, never>, Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, TMeta, never>;
|
|
421
|
+
interface ApiBuilderOpts<TMeta extends Meta> {
|
|
422
|
+
meta?: TMeta;
|
|
423
|
+
}
|
|
424
|
+
declare function createApiBuilder<TMeta extends Meta = Record<never, never>>(opts?: ApiBuilderOpts<TMeta>): ApiBuilder<TMeta>;
|
|
425
|
+
declare const os: ApiBuilder<Record<never, never>>;
|
|
426
|
+
|
|
427
|
+
/**
|
|
428
|
+
* Like `DecoratedProcedure`, but removed all method that can change the contract.
|
|
429
|
+
*/
|
|
430
|
+
interface ImplementedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
431
|
+
/**
|
|
432
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
433
|
+
*
|
|
434
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
435
|
+
* @info Pass second argument to map the input.
|
|
436
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
437
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
438
|
+
*/
|
|
439
|
+
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>;
|
|
440
|
+
/**
|
|
441
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
442
|
+
*
|
|
443
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
444
|
+
* @info Pass second argument to map the input.
|
|
445
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
446
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
447
|
+
*/
|
|
448
|
+
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>;
|
|
449
|
+
/**
|
|
450
|
+
* Make this procedure callable (works like a function while still being a procedure).
|
|
451
|
+
*
|
|
452
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
453
|
+
*/
|
|
454
|
+
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta> & ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* Like `ProcedureBuilderWithoutHandler`, but removed all method that can change the contract.
|
|
458
|
+
*/
|
|
459
|
+
interface ProcedureImplementer<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
460
|
+
'~orpc': BuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta, string>;
|
|
461
|
+
/**
|
|
462
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
463
|
+
*
|
|
464
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
465
|
+
* @info Pass second argument to map the input.
|
|
466
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
467
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
468
|
+
*/
|
|
469
|
+
'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>;
|
|
470
|
+
/**
|
|
471
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
472
|
+
*
|
|
473
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
474
|
+
* @info Pass second argument to map the input.
|
|
475
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
476
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
477
|
+
*/
|
|
478
|
+
'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>;
|
|
479
|
+
/**
|
|
480
|
+
* Defines the handler of the procedure.
|
|
481
|
+
*
|
|
482
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
483
|
+
*/
|
|
484
|
+
'handler'(handler: ProcedureHandler<TCurrentContext, InferSchemaOutput<TInputSchema>, InferSchemaInput<TOutputSchema>, TErrorMap, TMeta>): ImplementedProcedure<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
|
488
|
+
/**
|
|
489
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
490
|
+
*
|
|
491
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
492
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
493
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
494
|
+
*/
|
|
495
|
+
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>>;
|
|
496
|
+
/**
|
|
497
|
+
* Applies all of the previously defined options to the specified router.
|
|
498
|
+
* And enforces the router match the contract.
|
|
499
|
+
*
|
|
500
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
501
|
+
*/
|
|
502
|
+
router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
503
|
+
/**
|
|
504
|
+
* Create a lazy router
|
|
505
|
+
* And applies all of the previously defined options to the specified router.
|
|
506
|
+
* And enforces the router match the contract.
|
|
507
|
+
*
|
|
508
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
509
|
+
*/
|
|
510
|
+
lazyRoute<U extends Router<T, TInitialContext>>(loader: () => Promise<{
|
|
511
|
+
default: U;
|
|
512
|
+
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
513
|
+
}
|
|
514
|
+
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> & {
|
|
515
|
+
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternalWithMiddlewares<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
516
|
+
};
|
|
517
|
+
|
|
518
|
+
interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
|
519
|
+
/**
|
|
520
|
+
* Creates a middleware.
|
|
521
|
+
*
|
|
522
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
523
|
+
*/
|
|
524
|
+
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
525
|
+
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, InferContractRouterMeta<T>>;
|
|
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.unnoq.com/docs/middleware Middleware Docs}
|
|
532
|
+
*/
|
|
533
|
+
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>>;
|
|
534
|
+
/**
|
|
535
|
+
* Applies all of the previously defined options to the specified router.
|
|
536
|
+
* And enforces the router match the contract.
|
|
537
|
+
*
|
|
538
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
539
|
+
*/
|
|
540
|
+
router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
541
|
+
/**
|
|
542
|
+
* Create a lazy router
|
|
543
|
+
* And applies all of the previously defined options to the specified router.
|
|
544
|
+
* And enforces the router match the contract.
|
|
545
|
+
*
|
|
546
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
547
|
+
*/
|
|
548
|
+
lazyRoute<U extends Router<T, TCurrentContext>>(loader: () => Promise<{
|
|
549
|
+
default: U;
|
|
550
|
+
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
551
|
+
}
|
|
552
|
+
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> & {
|
|
553
|
+
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternal<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
554
|
+
};
|
|
555
|
+
declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
|
|
556
|
+
type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
|
|
557
|
+
/**
|
|
558
|
+
* Set or override the initial context.
|
|
559
|
+
*
|
|
560
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
561
|
+
*/
|
|
562
|
+
$context<U extends Context>(): Implementer<TContract, U & Record<never, never>, U>;
|
|
563
|
+
} & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
|
|
564
|
+
declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T): Implementer<T, TContext, TContext>;
|
|
565
|
+
|
|
566
|
+
declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
|
|
567
|
+
declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
|
|
568
|
+
dedupeLeading: boolean;
|
|
569
|
+
}): readonly AnyMiddleware[];
|
|
570
|
+
declare function addMiddleware(middlewares: readonly AnyMiddleware[], addition: AnyMiddleware): AnyMiddleware[];
|
|
571
|
+
|
|
572
|
+
declare function createAssertedLazyProcedure(lazied: Lazy<any>): Lazy<AnyProcedure>;
|
|
573
|
+
/**
|
|
574
|
+
* Create a new procedure that ensure the contract is applied to the procedure.
|
|
575
|
+
*/
|
|
576
|
+
declare function createContractedProcedure(procedure: AnyProcedure, contract: AnyContractProcedure): AnyProcedure;
|
|
577
|
+
/**
|
|
578
|
+
* Directly call a procedure without creating a client.
|
|
579
|
+
*
|
|
580
|
+
* @example
|
|
581
|
+
* ```ts
|
|
582
|
+
* const output = await call(getting, 'input')
|
|
583
|
+
* const output = await call(getting, 'input', { context: { db: 'postgres' } })
|
|
584
|
+
* ```
|
|
585
|
+
*
|
|
586
|
+
*/
|
|
587
|
+
declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
588
|
+
|
|
589
|
+
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
|
|
590
|
+
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
|
591
|
+
};
|
|
592
|
+
/**
|
|
593
|
+
* Create Server-side client from a router.
|
|
594
|
+
*
|
|
595
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
596
|
+
*/
|
|
597
|
+
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>;
|
|
598
|
+
|
|
599
|
+
declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
|
|
600
|
+
declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
|
|
601
|
+
|
|
602
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createApiBuilder, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, getHiddenRouterContract, getRouter, implement, implementerInternal, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
|
|
603
|
+
export type { AccessibleLazyRouter, ApiBuilder, BuilderDef, BuilderWithMiddlewares, ContractProcedureCallbackOptions, DecoratedMiddleware, EnhanceRouterOptions, EnhancedRouter, ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, LazyTraverseContractProceduresOptions, ProcedureBuilder, ProcedureImplementer, RouterBuilder, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, TraverseContractProcedureCallbackOptions, TraverseContractProceduresOptions, UnlaziedRouter };
|