@orpc/server 0.0.0-next.904b0c2 → 0.0.0-next.90a7c1e

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