@temporary-name/server 1.9.3-alpha.21b0289906d115f2f3db137ea407a6d8d50b5ad6 → 1.9.3-alpha.2957dbc009ec31fa21575f028b83c96651cba827
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/dist/adapters/aws-lambda/index.d.mts +3 -4
- package/dist/adapters/aws-lambda/index.d.ts +3 -4
- package/dist/adapters/aws-lambda/index.mjs +3 -3
- package/dist/adapters/fetch/index.d.mts +7 -84
- package/dist/adapters/fetch/index.d.ts +7 -84
- package/dist/adapters/fetch/index.mjs +15 -154
- package/dist/adapters/node/index.d.mts +7 -61
- package/dist/adapters/node/index.d.ts +7 -61
- package/dist/adapters/node/index.mjs +13 -119
- package/dist/adapters/standard/index.d.mts +4 -5
- package/dist/adapters/standard/index.d.ts +4 -5
- package/dist/adapters/standard/index.mjs +4 -4
- package/dist/helpers/index.mjs +3 -29
- package/dist/index.d.mts +60 -191
- package/dist/index.d.ts +60 -191
- package/dist/index.mjs +96 -104
- package/dist/openapi/index.d.mts +9 -26
- package/dist/openapi/index.d.ts +9 -26
- package/dist/openapi/index.mjs +6 -74
- package/dist/shared/{server.DmGicgbG.mjs → server.B7tjiDal.mjs} +46 -105
- package/dist/shared/server.C1RJffw4.mjs +30 -0
- package/dist/shared/server.CQIFwyhc.mjs +40 -0
- package/dist/shared/server.CpS0m3at.mjs +403 -0
- package/dist/shared/server.DPD7R7h_.d.mts +226 -0
- package/dist/shared/server.DPD7R7h_.d.ts +226 -0
- package/dist/shared/server.DfUs5c4R.d.ts +41 -0
- package/dist/shared/server.L8lRAYBR.d.mts +41 -0
- package/package.json +10 -27
- package/dist/plugins/index.d.mts +0 -159
- package/dist/plugins/index.d.ts +0 -159
- package/dist/plugins/index.mjs +0 -288
- package/dist/shared/server.7aL9gcoU.d.mts +0 -23
- package/dist/shared/server.BL2R5jcp.d.mts +0 -228
- package/dist/shared/server.BL2R5jcp.d.ts +0 -228
- package/dist/shared/server.CttFCjkj.mjs +0 -255
- package/dist/shared/server.D6Qs_UcF.d.mts +0 -55
- package/dist/shared/server.DFptr1Nz.d.ts +0 -23
- package/dist/shared/server.DpoO_ER_.d.ts +0 -55
- package/dist/shared/server.JtIZ8YG7.mjs +0 -237
package/dist/index.d.ts
CHANGED
|
@@ -1,48 +1,55 @@
|
|
|
1
|
-
import { Schemas,
|
|
2
|
-
export {
|
|
3
|
-
import { ClientContext, MaybeOptionalOptions, HTTPEndpoint, IntersectPick, HTTPPath, ClientOptions
|
|
4
|
-
export { AsyncIteratorClass, ClientContext, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, HTTPMethod, HTTPPath, IntersectPick, ORPCError,
|
|
1
|
+
import { Schemas, InferProcedureClientInputs, InferSchemaOutput, Meta, AnyShape, MergedSchemas, WrapShape, UnionToIntersection, AnySchema, Route, InferHandlerInputs, InferSchemaInput, InitialSchemas } from '@temporary-name/contract';
|
|
2
|
+
export { InferSchemaInput, InferSchemaOutput, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator } from '@temporary-name/contract';
|
|
3
|
+
import { ClientContext, Value, Promisable, Client, MaybeOptionalOptions, HTTPEndpoint, IntersectPick, OptionalIfEmpty, HTTPPath, ClientOptions } from '@temporary-name/shared';
|
|
4
|
+
export { AsyncIteratorClass, ClientContext, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, HTTPMethod, HTTPPath, IntersectPick, ORPCError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
|
|
5
5
|
import { SchemaClass, core } from '@temporary-name/zod';
|
|
6
|
-
import { C as Context, P as Procedure, a as
|
|
7
|
-
export { T as AccessibleLazyRouter,
|
|
6
|
+
import { C as Context, L as Lazyable, P as Procedure, a as Contract, M as Middleware, b as MergedInitialContext, c as MergedCurrentContext, A as AuthType, V as ValidatedAuthContext, d as AuthConfig, B as BuildContextWithAuth, e as ProcedureHandler, E as EnhanceRouterOptions, R as Router, f as EnhancedRouter, g as MapInputMiddleware, h as ContractDef, i as AnyMiddleware, j as Lazy, k as AnyProcedure, l as AnyRouter, I as InferRouterInitialContext } from './shared/server.DPD7R7h_.js';
|
|
7
|
+
export { T as AccessibleLazyRouter, F as AnyContractDef, Z as ContractProcedureCallbackOptions, J as ContractRouter, D as DefaultProcedureHandlerOptions, N as InferRouterCurrentContexts, K as InferRouterInitialContexts, O as InferRouterInputs, Q as InferRouterOutputs, n as LAZY_SYMBOL, o as LazyMeta, _ as LazyTraverseContractProceduresOptions, v as MiddlewareNextFn, x as MiddlewareOptions, w as MiddlewareOutputFn, t as MiddlewareResult, G as ProcedureDef, z as ProcedureHandlerOptions, Y as TraverseContractProcedureCallbackOptions, X as TraverseContractProceduresOptions, a1 as UnlaziedRouter, U as createAccessibleLazyRouter, W as enhanceRouter, s as getLazyMeta, S as getRouter, r as isLazy, H as isProcedure, q as lazy, p as lazyInternal, m as mergeCurrentContext, y as middlewareOutputFn, a0 as resolveContractProcedures, $ as traverseContractProcedures, u as unlazy, a2 as unlazyRouter } from './shared/server.DPD7R7h_.js';
|
|
8
8
|
export { getEventMeta, withEventMeta } from '@temporary-name/standard-server';
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
type ProcedureClient<TClientContext extends ClientContext, TSchemas extends Schemas> = Client<TClientContext, InferProcedureClientInputs<TSchemas>, InferSchemaOutput<TSchemas['outputSchema']>>;
|
|
11
|
+
type CreateProcedureClientOptions<TInitialContext extends Context, TClientContext extends ClientContext> = {
|
|
12
|
+
/**
|
|
13
|
+
* This is helpful for logging and analytics.
|
|
14
|
+
*/
|
|
15
|
+
path?: readonly string[];
|
|
16
|
+
} & (Record<never, never> extends TInitialContext ? {
|
|
17
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
18
|
+
} : {
|
|
19
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
20
|
+
});
|
|
21
|
+
/**
|
|
22
|
+
* Create Server-side client from a procedure.
|
|
23
|
+
*
|
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
25
|
+
*/
|
|
26
|
+
declare function createProcedureClient<TInitialContext extends Context, TSchemas extends Schemas, TMeta extends Meta, TClientContext extends ClientContext>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TSchemas, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TClientContext>>): ProcedureClient<TClientContext, TSchemas>;
|
|
27
|
+
|
|
28
|
+
declare class DecoratedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TSchemas, TMeta> {
|
|
11
29
|
/**
|
|
12
30
|
* Make this procedure callable (works like a function while still being a procedure).
|
|
13
31
|
*
|
|
14
32
|
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
15
33
|
*/
|
|
16
|
-
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext,
|
|
34
|
+
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TSchemas, TMeta> & ProcedureClient<TClientContext, TSchemas>;
|
|
17
35
|
}
|
|
18
36
|
|
|
19
|
-
declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
37
|
+
declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta, TGateName extends string> extends Contract<BuilderDef<TSchemas, TMeta>> {
|
|
20
38
|
z: SchemaClass<TGateName>;
|
|
21
|
-
|
|
22
|
-
* This property holds the defined options.
|
|
23
|
-
*/
|
|
24
|
-
'~orpc': BuilderDef<TSchemas, TErrorMap, TMeta>;
|
|
25
|
-
constructor(def: BuilderDef<TSchemas, TErrorMap, TMeta>);
|
|
26
|
-
/**
|
|
27
|
-
* Adds type-safe custom errors to the contract.
|
|
28
|
-
* The provided errors are spared-merged with any existing errors in the contract.
|
|
29
|
-
*
|
|
30
|
-
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
31
|
-
*/
|
|
32
|
-
errors<U extends ErrorMap>(errors: U): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, MergedErrorMap<TErrorMap, U>, TMeta, TGateName>;
|
|
39
|
+
constructor(def: BuilderDef<TSchemas, TMeta>);
|
|
33
40
|
/**
|
|
34
41
|
* Sets or updates the metadata for the contract.
|
|
35
42
|
* The provided metadata is spared-merged with any existing metadata in the contract.
|
|
36
43
|
*
|
|
37
44
|
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
38
45
|
*/
|
|
39
|
-
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas,
|
|
46
|
+
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
40
47
|
endpoint<U extends AnyShape[]>(strings: TemplateStringsArray, ...values: [...U]): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
41
48
|
pathSchema: WrapShape<UnionToIntersection<U>>;
|
|
42
|
-
}>,
|
|
49
|
+
}>, TMeta, TGateName>;
|
|
43
50
|
endpoint<U extends AnySchema | AnyShape = core.$ZodType<Record<string, never>, Record<string, never>>>(endpoint: HTTPEndpoint, schema?: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
44
51
|
pathSchema: WrapShape<U>;
|
|
45
|
-
}>,
|
|
52
|
+
}>, TMeta, TGateName>;
|
|
46
53
|
/**
|
|
47
54
|
* Sets or updates the route definition for the contract.
|
|
48
55
|
* The provided route is spared-merged with any existing route in the contract.
|
|
@@ -51,13 +58,13 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
51
58
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
52
59
|
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
53
60
|
*/
|
|
54
|
-
endpointOpts(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas,
|
|
61
|
+
endpointOpts(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
55
62
|
query<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
56
63
|
querySchema: WrapShape<U>;
|
|
57
|
-
}>,
|
|
64
|
+
}>, TMeta, TGateName>;
|
|
58
65
|
body<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
59
66
|
bodySchema: WrapShape<U>;
|
|
60
|
-
}>,
|
|
67
|
+
}>, TMeta, TGateName>;
|
|
61
68
|
/**
|
|
62
69
|
* Defines the output validation schema.
|
|
63
70
|
*
|
|
@@ -65,7 +72,7 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
65
72
|
*/
|
|
66
73
|
output<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
67
74
|
outputSchema: WrapShape<U>;
|
|
68
|
-
}>,
|
|
75
|
+
}>, TMeta, TGateName>;
|
|
69
76
|
/**
|
|
70
77
|
* Uses a middleware to modify the context or improve the pipeline.
|
|
71
78
|
*
|
|
@@ -73,18 +80,19 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
73
80
|
* @note The current context must be satisfy middleware dependent-context
|
|
74
81
|
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
75
82
|
*/
|
|
76
|
-
use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown,
|
|
83
|
+
use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown, TMeta>): ProcedureBuilder<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TSchemas, TMeta, TGateName>;
|
|
84
|
+
useAuth<const TAuthType extends AuthType & {}, TAuthContext extends ValidatedAuthContext = false>(type: TAuthType, ...rest: OptionalIfEmpty<AuthConfig<TAuthType, TAuthContext>>): ProcedureBuilder<TInitialContext, BuildContextWithAuth<TCurrentContext, TAuthContext>, TSchemas, TMeta, TGateName>;
|
|
77
85
|
useGating<const TInferredGateName extends string>(gates: TInferredGateName[], isGateEnabled: (gate: TInferredGateName, ctx: TCurrentContext) => boolean): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, Context, TCurrentContext>, MergedCurrentContext<TCurrentContext, {
|
|
78
86
|
isGateEnabled: typeof isGateEnabled;
|
|
79
|
-
}>, TSchemas,
|
|
87
|
+
}>, TSchemas, TMeta, TInferredGateName>;
|
|
80
88
|
/**
|
|
81
89
|
* Defines the handler of the procedure.
|
|
82
90
|
*
|
|
83
91
|
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
84
92
|
*/
|
|
85
|
-
handler(handler: ProcedureHandler<TCurrentContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>,
|
|
93
|
+
handler(handler: ProcedureHandler<TCurrentContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TSchemas, TMeta>;
|
|
86
94
|
}
|
|
87
|
-
declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
95
|
+
declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta, TGateName extends string> extends ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName> {
|
|
88
96
|
/**
|
|
89
97
|
* Prefixes all procedures in the router.
|
|
90
98
|
* The provided prefix is post-appended to any existing router prefix.
|
|
@@ -93,206 +101,74 @@ declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentCo
|
|
|
93
101
|
*
|
|
94
102
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
95
103
|
*/
|
|
96
|
-
prefix(prefix: HTTPPath): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TSchemas,
|
|
104
|
+
prefix(prefix: HTTPPath): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
97
105
|
/**
|
|
98
106
|
* Adds tags to all procedures in the router.
|
|
99
107
|
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
100
108
|
*
|
|
101
109
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
102
110
|
*/
|
|
103
|
-
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext,
|
|
111
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TMeta>;
|
|
104
112
|
/**
|
|
105
113
|
* Applies all of the previously defined options to the specified router.
|
|
106
114
|
*
|
|
107
115
|
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
108
116
|
*/
|
|
109
|
-
router<U extends Router<
|
|
117
|
+
router<U extends Router<TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext>;
|
|
110
118
|
}
|
|
111
|
-
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context,
|
|
119
|
+
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TMeta extends Meta> extends Pick<BuilderWithMiddlewares<TInitialContext, TCurrentContext, any, TMeta, any>, 'prefix' | 'tag' | 'router'> {
|
|
112
120
|
/**
|
|
113
121
|
* This property holds the defined options.
|
|
114
122
|
*/
|
|
115
|
-
'~orpc': EnhanceRouterOptions
|
|
123
|
+
'~orpc': EnhanceRouterOptions;
|
|
116
124
|
}
|
|
117
125
|
|
|
118
|
-
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput,
|
|
126
|
+
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TMeta extends Meta> extends Middleware<TInContext, TOutContext, TInput, TOutput, TMeta> {
|
|
119
127
|
/**
|
|
120
128
|
* Change the expected input type by providing a map function.
|
|
121
129
|
*/
|
|
122
|
-
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput,
|
|
130
|
+
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput, TMeta>;
|
|
123
131
|
/**
|
|
124
132
|
* Concatenates two middlewares.
|
|
125
133
|
*
|
|
126
134
|
* @info Pass second argument to map the input.
|
|
127
135
|
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
128
136
|
*/
|
|
129
|
-
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,
|
|
137
|
+
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, TMeta>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TMeta>;
|
|
130
138
|
/**
|
|
131
139
|
* Concatenates two middlewares.
|
|
132
140
|
*
|
|
133
141
|
* @info Pass second argument to map the input.
|
|
134
142
|
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
135
143
|
*/
|
|
136
|
-
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,
|
|
144
|
+
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, TMeta>, mapInput: MapInputMiddleware<UInput, UMappedInput>): DecoratedMiddleware<MergedInitialContext<TInContext, UInContext, MergedCurrentContext<TInContext, TOutContext>>, MergedCurrentContext<TOutContext, UOutContext>, UInput, TOutput, TMeta>;
|
|
137
145
|
}
|
|
138
|
-
declare function decorateMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput,
|
|
146
|
+
declare function decorateMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TMeta extends Meta>(middleware: Middleware<TInContext, TOutContext, TInput, TOutput, TMeta>): DecoratedMiddleware<TInContext, TOutContext, TInput, TOutput, TMeta>;
|
|
139
147
|
|
|
140
|
-
interface BuilderDef<TSchemas extends Schemas,
|
|
141
|
-
middlewares: readonly AnyMiddleware[];
|
|
142
|
-
inputValidationIndex: number;
|
|
143
|
-
outputValidationIndex: number;
|
|
148
|
+
interface BuilderDef<TSchemas extends Schemas, TMeta extends Meta> extends ContractDef<any, TSchemas, TMeta>, EnhanceRouterOptions {
|
|
144
149
|
}
|
|
145
|
-
declare class Builder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
150
|
+
declare class Builder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta, TGateName extends string> extends BuilderWithMiddlewares<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName> {
|
|
146
151
|
/**
|
|
147
152
|
* Set or override the initial context.
|
|
148
153
|
*
|
|
149
154
|
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
150
155
|
*/
|
|
151
|
-
$context<U extends Context>(): Builder<U, U, TSchemas,
|
|
156
|
+
$context<U extends Context>(): Builder<U, U, TSchemas, TMeta, TGateName>;
|
|
152
157
|
/**
|
|
153
158
|
* Creates a middleware.
|
|
154
159
|
*
|
|
155
160
|
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
156
161
|
*/
|
|
157
162
|
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
158
|
-
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput,
|
|
163
|
+
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, TMeta>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, TMeta>;
|
|
159
164
|
}
|
|
160
|
-
type ApiBuilder<TMeta extends Meta> = Builder<Record<never, never>, Record<never, never>, InitialSchemas,
|
|
165
|
+
type ApiBuilder<TMeta extends Meta> = Builder<Record<never, never>, Record<never, never>, InitialSchemas, TMeta, never>;
|
|
161
166
|
interface ApiBuilderOpts<TMeta extends Meta> {
|
|
162
167
|
meta?: TMeta;
|
|
163
168
|
}
|
|
164
169
|
declare function createApiBuilder<TMeta extends Meta = Record<never, never>>(opts?: ApiBuilderOpts<TMeta>): ApiBuilder<TMeta>;
|
|
165
170
|
declare const os: ApiBuilder<Record<never, never>>;
|
|
166
171
|
|
|
167
|
-
/**
|
|
168
|
-
* Like `DecoratedProcedure`, but removed all method that can change the contract.
|
|
169
|
-
*/
|
|
170
|
-
interface ImplementedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TErrorMap extends ErrorMap, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TSchemas, TErrorMap, TMeta> {
|
|
171
|
-
/**
|
|
172
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
173
|
-
*
|
|
174
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
175
|
-
* @info Pass second argument to map the input.
|
|
176
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
177
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
178
|
-
*/
|
|
179
|
-
use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TSchemas, TErrorMap, TMeta>;
|
|
180
|
-
/**
|
|
181
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
182
|
-
*
|
|
183
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
184
|
-
* @info Pass second argument to map the input.
|
|
185
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
186
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
187
|
-
*/
|
|
188
|
-
use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TSchemas['outputSchema']>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferHandlerInputs<TSchemas>, UInput>): ImplementedProcedure<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TSchemas, TErrorMap, TMeta>;
|
|
189
|
-
/**
|
|
190
|
-
* Make this procedure callable (works like a function while still being a procedure).
|
|
191
|
-
*
|
|
192
|
-
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
193
|
-
*/
|
|
194
|
-
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TSchemas['outputSchema'], TErrorMap, TMeta, TClientContext>>): ImplementedProcedure<TInitialContext, TCurrentContext, TSchemas, TErrorMap, TMeta> & ProcedureClient<TClientContext, TSchemas, TErrorMap>;
|
|
195
|
-
}
|
|
196
|
-
/**
|
|
197
|
-
* Like `ProcedureBuilderWithoutHandler`, but removed all method that can change the contract.
|
|
198
|
-
*/
|
|
199
|
-
interface ProcedureImplementer<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
200
|
-
'~orpc': BuilderDef<TSchemas, TErrorMap, TMeta>;
|
|
201
|
-
/**
|
|
202
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
203
|
-
*
|
|
204
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
205
|
-
* @info Pass second argument to map the input.
|
|
206
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
207
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
208
|
-
*/
|
|
209
|
-
'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>, ORPCErrorConstructorMap<TErrorMap>, TMeta>): ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TSchemas, TErrorMap, TMeta>;
|
|
210
|
-
/**
|
|
211
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
212
|
-
*
|
|
213
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
214
|
-
* @info Pass second argument to map the input.
|
|
215
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
216
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
217
|
-
*/
|
|
218
|
-
'use'<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInput, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, UInput, InferSchemaInput<TSchemas['outputSchema']>, ORPCErrorConstructorMap<TErrorMap>, TMeta>, mapInput: MapInputMiddleware<InferHandlerInputs<TSchemas>, UInput>): ProcedureImplementer<MergedInitialContext<TInitialContext, UInContext, TCurrentContext>, MergedCurrentContext<TCurrentContext, UOutContext>, TSchemas, TErrorMap, TMeta>;
|
|
219
|
-
/**
|
|
220
|
-
* Defines the handler of the procedure.
|
|
221
|
-
*
|
|
222
|
-
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
223
|
-
*/
|
|
224
|
-
'handler'(handler: ProcedureHandler<TCurrentContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>, TErrorMap, TMeta>): ImplementedProcedure<TInitialContext, TCurrentContext, TSchemas, TErrorMap, TMeta>;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
|
228
|
-
/**
|
|
229
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
230
|
-
*
|
|
231
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
232
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
233
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
234
|
-
*/
|
|
235
|
-
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>>;
|
|
236
|
-
/**
|
|
237
|
-
* Applies all of the previously defined options to the specified router.
|
|
238
|
-
* And enforces the router match the contract.
|
|
239
|
-
*
|
|
240
|
-
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
241
|
-
*/
|
|
242
|
-
router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
243
|
-
}
|
|
244
|
-
type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer USchemas, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, USchemas, UErrorMap, UMeta> : RouterImplementerWithMiddlewares<TContract, TInitialContext, TCurrentContext> & {
|
|
245
|
-
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternalWithMiddlewares<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
246
|
-
};
|
|
247
|
-
|
|
248
|
-
interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
|
|
249
|
-
/**
|
|
250
|
-
* Creates a middleware.
|
|
251
|
-
*
|
|
252
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
253
|
-
*/
|
|
254
|
-
middleware<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, TInput, TOutput = any>(// = any here is important to make middleware can be used in any output by default
|
|
255
|
-
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, ORPCErrorConstructorMap<InferContractRouterErrorMap<T>>, InferContractRouterMeta<T>>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, any, InferContractRouterMeta<T>>;
|
|
256
|
-
/**
|
|
257
|
-
* Uses a middleware to modify the context or improve the pipeline.
|
|
258
|
-
*
|
|
259
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
260
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
261
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
262
|
-
*/
|
|
263
|
-
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>>;
|
|
264
|
-
/**
|
|
265
|
-
* Applies all of the previously defined options to the specified router.
|
|
266
|
-
* And enforces the router match the contract.
|
|
267
|
-
*
|
|
268
|
-
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
269
|
-
*/
|
|
270
|
-
router<U extends Router<T, TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
271
|
-
/**
|
|
272
|
-
* Create a lazy router
|
|
273
|
-
* And applies all of the previously defined options to the specified router.
|
|
274
|
-
* And enforces the router match the contract.
|
|
275
|
-
*
|
|
276
|
-
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
277
|
-
*/
|
|
278
|
-
lazyRoute<U extends Router<T, TCurrentContext>>(loader: () => Promise<{
|
|
279
|
-
default: U;
|
|
280
|
-
}>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
|
|
281
|
-
}
|
|
282
|
-
type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer USchemas, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, USchemas, UErrorMap, UMeta> : RouterImplementer<TContract, TInitialContext, TCurrentContext> & {
|
|
283
|
-
[K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternal<TContract[K], TInitialContext, TCurrentContext> : never;
|
|
284
|
-
};
|
|
285
|
-
declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
|
|
286
|
-
type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
|
|
287
|
-
/**
|
|
288
|
-
* Set or override the initial context.
|
|
289
|
-
*
|
|
290
|
-
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
291
|
-
*/
|
|
292
|
-
$context<U extends Context>(): Implementer<TContract, U, U>;
|
|
293
|
-
} & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
|
|
294
|
-
declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T): Implementer<T, TContext, TContext>;
|
|
295
|
-
|
|
296
172
|
declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
|
|
297
173
|
declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
|
|
298
174
|
dedupeLeading: boolean;
|
|
@@ -300,10 +176,6 @@ declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: reado
|
|
|
300
176
|
declare function addMiddleware(middlewares: readonly AnyMiddleware[], addition: AnyMiddleware): AnyMiddleware[];
|
|
301
177
|
|
|
302
178
|
declare function createAssertedLazyProcedure(lazied: Lazy<any>): Lazy<AnyProcedure>;
|
|
303
|
-
/**
|
|
304
|
-
* Create a new procedure that ensure the contract is applied to the procedure.
|
|
305
|
-
*/
|
|
306
|
-
declare function createContractedProcedure(procedure: AnyProcedure, contract: AnyContractProcedure): AnyProcedure;
|
|
307
179
|
/**
|
|
308
180
|
* Directly call a procedure without creating a client.
|
|
309
181
|
*
|
|
@@ -314,9 +186,9 @@ declare function createContractedProcedure(procedure: AnyProcedure, contract: An
|
|
|
314
186
|
* ```
|
|
315
187
|
*
|
|
316
188
|
*/
|
|
317
|
-
declare function call<TInitialContext extends Context, TSchemas extends Schemas,
|
|
189
|
+
declare function call<TInitialContext extends Context, TSchemas extends Schemas, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TSchemas, TMeta>>, input: InferProcedureClientInputs<TSchemas>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): Promise<InferSchemaOutput<TSchemas['outputSchema']>>;
|
|
318
190
|
|
|
319
|
-
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer USchemas,
|
|
191
|
+
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer USchemas, any> ? ProcedureClient<TClientContext, USchemas> : {
|
|
320
192
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
|
321
193
|
};
|
|
322
194
|
/**
|
|
@@ -324,10 +196,7 @@ type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContex
|
|
|
324
196
|
*
|
|
325
197
|
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
326
198
|
*/
|
|
327
|
-
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>,
|
|
328
|
-
|
|
329
|
-
declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
|
|
330
|
-
declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
|
|
199
|
+
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, TClientContext>>): RouterClient<T, TClientContext>;
|
|
331
200
|
|
|
332
|
-
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, BuilderWithMiddlewares, Context,
|
|
333
|
-
export type { ApiBuilder, BuilderDef,
|
|
201
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, BuildContextWithAuth, Builder, BuilderWithMiddlewares, Context, Contract, ContractDef, DecoratedProcedure, EnhanceRouterOptions, EnhancedRouter, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, Procedure, ProcedureBuilder, ProcedureHandler, Router, addMiddleware, call, createApiBuilder, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, isStartWithMiddlewares, mergeMiddlewares, os };
|
|
202
|
+
export type { ApiBuilder, BuilderDef, CreateProcedureClientOptions, DecoratedMiddleware, ProcedureClient, RouterBuilder, RouterClient };
|