@temporary-name/server 1.9.3-alpha.8dcf0da5d97e7b89ab5ce50c8d1733c158e629a8 → 1.9.3-alpha.907c7c78d0193d34752279de92d699e50d6bc3a1
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 +4 -6
- package/dist/adapters/aws-lambda/index.d.ts +4 -6
- package/dist/adapters/aws-lambda/index.mjs +4 -4
- package/dist/adapters/fetch/index.d.mts +8 -86
- package/dist/adapters/fetch/index.d.ts +8 -86
- package/dist/adapters/fetch/index.mjs +16 -155
- package/dist/adapters/node/index.d.mts +8 -63
- package/dist/adapters/node/index.d.ts +8 -63
- package/dist/adapters/node/index.mjs +14 -120
- package/dist/adapters/standard/index.d.mts +5 -7
- package/dist/adapters/standard/index.d.ts +5 -7
- package/dist/adapters/standard/index.mjs +4 -4
- package/dist/helpers/index.mjs +3 -29
- package/dist/index.d.mts +104 -182
- package/dist/index.d.ts +104 -182
- package/dist/index.mjs +126 -104
- package/dist/openapi/index.d.mts +11 -27
- package/dist/openapi/index.d.ts +11 -27
- package/dist/openapi/index.mjs +8 -75
- package/dist/shared/server.Bj_UpI5O.d.mts +372 -0
- package/dist/shared/server.Bj_UpI5O.d.ts +372 -0
- package/dist/shared/server.C1RJffw4.mjs +30 -0
- package/dist/shared/server.C6VnFy4S.d.mts +41 -0
- package/dist/shared/server.CQIFwyhc.mjs +40 -0
- package/dist/shared/server.ChOv1yG3.mjs +319 -0
- package/dist/shared/server.CnzXkSjj.d.ts +41 -0
- package/dist/shared/server.DXzEGRE2.mjs +403 -0
- package/dist/shared/server.DgzAlPjF.mjs +160 -0
- package/dist/shared/server.YUvuxHty.mjs +48 -0
- package/package.json +10 -27
- package/dist/plugins/index.d.mts +0 -160
- package/dist/plugins/index.d.ts +0 -160
- package/dist/plugins/index.mjs +0 -288
- package/dist/shared/server.BSJugGGA.d.mts +0 -56
- package/dist/shared/server.Bs8EZATl.d.ts +0 -23
- package/dist/shared/server.CHV9AQHl.mjs +0 -412
- package/dist/shared/server.CWWP8ypC.d.mts +0 -239
- package/dist/shared/server.CWWP8ypC.d.ts +0 -239
- package/dist/shared/server.Cn7WsRHl.mjs +0 -254
- package/dist/shared/server.DrMgIiBr.d.mts +0 -23
- package/dist/shared/server.EKwDe0d2.d.ts +0 -56
- package/dist/shared/server.JtIZ8YG7.mjs +0 -237
package/dist/index.d.mts
CHANGED
|
@@ -1,48 +1,53 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
3
|
-
import { ClientContext, MaybeOptionalOptions, HTTPEndpoint, IntersectPick, HTTPPath, ClientOptions, ClientPromiseResult } from '@temporary-name/shared';
|
|
4
|
-
export { AsyncIteratorClass, ClientContext, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, HTTPMethod, HTTPPath, IntersectPick, ORPCError, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, safe, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
|
|
1
|
+
import { ClientContext, Value, Promisable, Client, MaybeOptionalOptions, HTTPEndpoint as HTTPEndpoint$1, IntersectPick, OptionalIfEmpty, HTTPPath, AsyncIteratorClass, ClientOptions, HTTPMethod } from '@temporary-name/shared';
|
|
2
|
+
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
3
|
import { SchemaClass, core } from '@temporary-name/zod';
|
|
6
|
-
import { C as Context,
|
|
7
|
-
export {
|
|
4
|
+
import { C as Context, S as Schemas, I as InferProcedureClientInputs, a as InferSchemaOutput, M as Meta, L as Lazyable, P as Procedure, b as Contract, A as AnyShape, c as MergedSchemas, W as WrapShape, U as UnionToIntersection, d as AnySchema, R as Route, e as Middleware, f as MergedInitialContext, g as MergedCurrentContext, h as AuthType, V as ValidatedAuthContext, i as AuthConfig, B as BuildContextWithAuth, j as ProcedureHandler, k as InferHandlerInputs, l as InferSchemaInput, E as EnhanceRouterOptions, m as Router, n as EnhancedRouter, o as MapInputMiddleware, p as ContractDef, q as InitialSchemas, r as SchemaIssue, s as Schema, t as AnyMiddleware, u as Lazy, v as AnyProcedure, w as AnyRouter, x as InferRouterInitialContext } from './shared/server.Bj_UpI5O.mjs';
|
|
5
|
+
export { a8 as AccessibleLazyRouter, $ as AnyContractDef, ad as ContractProcedureCallbackOptions, a2 as ContractRouter, Z as DefaultProcedureHandlerOptions, a4 as InferRouterCurrentContexts, a3 as InferRouterInitialContexts, a5 as InferRouterInputs, a6 as InferRouterOutputs, z as LAZY_SYMBOL, D as LazyMeta, ae as LazyTraverseContractProceduresOptions, Q as MiddlewareNextFn, X as MiddlewareOptions, T as MiddlewareOutputFn, O as MiddlewareResult, a0 as ProcedureDef, _ as ProcedureHandlerOptions, ac as TraverseContractProcedureCallbackOptions, ab as TraverseContractProceduresOptions, aj as TypeRest, ah as UnlaziedRouter, a9 as createAccessibleLazyRouter, aa as enhanceRouter, J as getLazyMeta, a7 as getRouter, ak as initialSchemas, H as isLazy, a1 as isProcedure, G as lazy, F as lazyInternal, y as mergeCurrentContext, N as mergeMeta, Y as middlewareOutputFn, ag as resolveContractProcedures, af as traverseContractProcedures, K as unlazy, ai as unlazyRouter } from './shared/server.Bj_UpI5O.mjs';
|
|
8
6
|
export { getEventMeta, withEventMeta } from '@temporary-name/standard-server';
|
|
9
7
|
|
|
10
|
-
|
|
8
|
+
type ProcedureClient<TClientContext extends ClientContext, TSchemas extends Schemas> = Client<TClientContext, InferProcedureClientInputs<TSchemas>, InferSchemaOutput<TSchemas['outputSchema']>>;
|
|
9
|
+
type CreateProcedureClientOptions<TInitialContext extends Context, TClientContext extends ClientContext> = {
|
|
10
|
+
/**
|
|
11
|
+
* This is helpful for logging and analytics.
|
|
12
|
+
*/
|
|
13
|
+
path?: readonly string[];
|
|
14
|
+
} & (Record<never, never> extends TInitialContext ? {
|
|
15
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
16
|
+
} : {
|
|
17
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
18
|
+
});
|
|
19
|
+
/**
|
|
20
|
+
* Create Server-side client from a procedure.
|
|
21
|
+
*
|
|
22
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
23
|
+
*/
|
|
24
|
+
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>;
|
|
25
|
+
|
|
26
|
+
declare class DecoratedProcedure<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta> extends Procedure<TInitialContext, TCurrentContext, TSchemas, TMeta> {
|
|
11
27
|
/**
|
|
12
28
|
* Make this procedure callable (works like a function while still being a procedure).
|
|
13
29
|
*
|
|
14
30
|
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
15
31
|
*/
|
|
16
|
-
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext,
|
|
32
|
+
callable<TClientContext extends ClientContext>(...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TClientContext>>): DecoratedProcedure<TInitialContext, TCurrentContext, TSchemas, TMeta> & ProcedureClient<TClientContext, TSchemas>;
|
|
17
33
|
}
|
|
18
34
|
|
|
19
|
-
declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
35
|
+
declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas, TMeta extends Meta, TGateName extends string> extends Contract<BuilderDef<TSchemas, TMeta>> {
|
|
20
36
|
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>;
|
|
37
|
+
constructor(def: BuilderDef<TSchemas, TMeta>);
|
|
33
38
|
/**
|
|
34
39
|
* Sets or updates the metadata for the contract.
|
|
35
40
|
* The provided metadata is spared-merged with any existing metadata in the contract.
|
|
36
41
|
*
|
|
37
42
|
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
38
43
|
*/
|
|
39
|
-
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas,
|
|
44
|
+
meta(meta: TMeta): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
40
45
|
endpoint<U extends AnyShape[]>(strings: TemplateStringsArray, ...values: [...U]): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
41
46
|
pathSchema: WrapShape<UnionToIntersection<U>>;
|
|
42
|
-
}>,
|
|
43
|
-
endpoint<U extends AnySchema | AnyShape = core.$ZodType<Record<string, never>, Record<string, never>>>(endpoint: HTTPEndpoint, schema?: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
47
|
+
}>, TMeta, TGateName>;
|
|
48
|
+
endpoint<U extends AnySchema | AnyShape = core.$ZodType<Record<string, never>, Record<string, never>>>(endpoint: HTTPEndpoint$1, schema?: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
44
49
|
pathSchema: WrapShape<U>;
|
|
45
|
-
}>,
|
|
50
|
+
}>, TMeta, TGateName>;
|
|
46
51
|
/**
|
|
47
52
|
* Sets or updates the route definition for the contract.
|
|
48
53
|
* The provided route is spared-merged with any existing route in the contract.
|
|
@@ -51,13 +56,13 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
51
56
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
52
57
|
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
53
58
|
*/
|
|
54
|
-
endpointOpts(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas,
|
|
59
|
+
endpointOpts(route: Route): ProcedureBuilder<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
55
60
|
query<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
56
61
|
querySchema: WrapShape<U>;
|
|
57
|
-
}>,
|
|
62
|
+
}>, TMeta, TGateName>;
|
|
58
63
|
body<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
59
64
|
bodySchema: WrapShape<U>;
|
|
60
|
-
}>,
|
|
65
|
+
}>, TMeta, TGateName>;
|
|
61
66
|
/**
|
|
62
67
|
* Defines the output validation schema.
|
|
63
68
|
*
|
|
@@ -65,7 +70,7 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
65
70
|
*/
|
|
66
71
|
output<U extends AnySchema | AnyShape>(schema: U): ProcedureBuilder<TInitialContext, TCurrentContext, MergedSchemas<TSchemas, {
|
|
67
72
|
outputSchema: WrapShape<U>;
|
|
68
|
-
}>,
|
|
73
|
+
}>, TMeta, TGateName>;
|
|
69
74
|
/**
|
|
70
75
|
* Uses a middleware to modify the context or improve the pipeline.
|
|
71
76
|
*
|
|
@@ -73,18 +78,19 @@ declare class ProcedureBuilder<TInitialContext extends Context, TCurrentContext
|
|
|
73
78
|
* @note The current context must be satisfy middleware dependent-context
|
|
74
79
|
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
75
80
|
*/
|
|
76
|
-
use<UOutContext extends IntersectPick<TCurrentContext, UOutContext>, UInContext extends Context = TCurrentContext>(middleware: Middleware<UInContext | TCurrentContext, UOutContext, unknown, unknown,
|
|
81
|
+
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>;
|
|
82
|
+
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
83
|
useGating<const TInferredGateName extends string>(gates: TInferredGateName[], isGateEnabled: (gate: TInferredGateName, ctx: TCurrentContext) => boolean): BuilderWithMiddlewares<MergedInitialContext<TInitialContext, Context, TCurrentContext>, MergedCurrentContext<TCurrentContext, {
|
|
78
84
|
isGateEnabled: typeof isGateEnabled;
|
|
79
|
-
}>, TSchemas,
|
|
85
|
+
}>, TSchemas, TMeta, TInferredGateName>;
|
|
80
86
|
/**
|
|
81
87
|
* Defines the handler of the procedure.
|
|
82
88
|
*
|
|
83
89
|
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
84
90
|
*/
|
|
85
|
-
handler(handler: ProcedureHandler<TCurrentContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>,
|
|
91
|
+
handler(handler: ProcedureHandler<TCurrentContext, InferHandlerInputs<TSchemas>, InferSchemaInput<TSchemas['outputSchema']>, TMeta>): DecoratedProcedure<TInitialContext, TCurrentContext, TSchemas, TMeta>;
|
|
86
92
|
}
|
|
87
|
-
declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
93
|
+
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
94
|
/**
|
|
89
95
|
* Prefixes all procedures in the router.
|
|
90
96
|
* The provided prefix is post-appended to any existing router prefix.
|
|
@@ -93,205 +99,104 @@ declare class BuilderWithMiddlewares<TInitialContext extends Context, TCurrentCo
|
|
|
93
99
|
*
|
|
94
100
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
95
101
|
*/
|
|
96
|
-
prefix(prefix: HTTPPath): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TSchemas,
|
|
102
|
+
prefix(prefix: HTTPPath): BuilderWithMiddlewares<TInitialContext, TCurrentContext, TSchemas, TMeta, TGateName>;
|
|
97
103
|
/**
|
|
98
104
|
* Adds tags to all procedures in the router.
|
|
99
105
|
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
100
106
|
*
|
|
101
107
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
102
108
|
*/
|
|
103
|
-
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext,
|
|
109
|
+
tag(...tags: string[]): RouterBuilder<TInitialContext, TCurrentContext, TMeta>;
|
|
104
110
|
/**
|
|
105
111
|
* Applies all of the previously defined options to the specified router.
|
|
106
112
|
*
|
|
107
113
|
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
108
114
|
*/
|
|
109
|
-
router<U extends Router<
|
|
115
|
+
router<U extends Router<TCurrentContext>>(router: U): EnhancedRouter<U, TInitialContext, TCurrentContext>;
|
|
110
116
|
}
|
|
111
|
-
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context,
|
|
117
|
+
interface RouterBuilder<TInitialContext extends Context, TCurrentContext extends Context, TMeta extends Meta> extends Pick<BuilderWithMiddlewares<TInitialContext, TCurrentContext, any, TMeta, any>, 'prefix' | 'tag' | 'router'> {
|
|
112
118
|
/**
|
|
113
119
|
* This property holds the defined options.
|
|
114
120
|
*/
|
|
115
|
-
'~orpc': EnhanceRouterOptions
|
|
121
|
+
'~orpc': EnhanceRouterOptions;
|
|
116
122
|
}
|
|
117
123
|
|
|
118
|
-
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput,
|
|
124
|
+
interface DecoratedMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TMeta extends Meta> extends Middleware<TInContext, TOutContext, TInput, TOutput, TMeta> {
|
|
119
125
|
/**
|
|
120
126
|
* Change the expected input type by providing a map function.
|
|
121
127
|
*/
|
|
122
|
-
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput,
|
|
128
|
+
mapInput<UInput>(map: MapInputMiddleware<UInput, TInput>): DecoratedMiddleware<TInContext, TOutContext, UInput, TOutput, TMeta>;
|
|
123
129
|
/**
|
|
124
130
|
* Concatenates two middlewares.
|
|
125
131
|
*
|
|
126
132
|
* @info Pass second argument to map the input.
|
|
127
133
|
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
128
134
|
*/
|
|
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,
|
|
135
|
+
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
136
|
/**
|
|
131
137
|
* Concatenates two middlewares.
|
|
132
138
|
*
|
|
133
139
|
* @info Pass second argument to map the input.
|
|
134
140
|
* @see {@link https://orpc.unnoq.com/docs/middleware#concatenation Middleware Concatenation Docs}
|
|
135
141
|
*/
|
|
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,
|
|
142
|
+
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
143
|
}
|
|
138
|
-
declare function decorateMiddleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput,
|
|
144
|
+
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
145
|
|
|
140
|
-
interface BuilderDef<TSchemas extends Schemas,
|
|
141
|
-
middlewares: readonly AnyMiddleware[];
|
|
142
|
-
inputValidationIndex: number;
|
|
143
|
-
outputValidationIndex: number;
|
|
146
|
+
interface BuilderDef<TSchemas extends Schemas, TMeta extends Meta> extends ContractDef<any, TSchemas, TMeta>, EnhanceRouterOptions {
|
|
144
147
|
}
|
|
145
|
-
declare class Builder<TInitialContext extends Context, TCurrentContext extends Context, TSchemas extends Schemas,
|
|
148
|
+
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
149
|
/**
|
|
147
150
|
* Set or override the initial context.
|
|
148
151
|
*
|
|
149
152
|
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
150
153
|
*/
|
|
151
|
-
$context<U extends Context>(): Builder<U, U, TSchemas,
|
|
154
|
+
$context<U extends Context>(): Builder<U, U, TSchemas, TMeta, TGateName>;
|
|
152
155
|
/**
|
|
153
156
|
* Creates a middleware.
|
|
154
157
|
*
|
|
155
158
|
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
156
159
|
*/
|
|
157
160
|
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,
|
|
161
|
+
middleware: Middleware<TInitialContext, UOutContext, TInput, TOutput, TMeta>): DecoratedMiddleware<TInitialContext, UOutContext, TInput, TOutput, TMeta>;
|
|
159
162
|
}
|
|
160
|
-
type ApiBuilder<TMeta extends Meta> = Builder<Record<never, never>, Record<never, never>, InitialSchemas,
|
|
163
|
+
type ApiBuilder<TMeta extends Meta> = Builder<Record<never, never>, Record<never, never>, InitialSchemas, TMeta, never>;
|
|
161
164
|
interface ApiBuilderOpts<TMeta extends Meta> {
|
|
162
165
|
meta?: TMeta;
|
|
163
166
|
}
|
|
164
167
|
declare function createApiBuilder<TMeta extends Meta = Record<never, never>>(opts?: ApiBuilderOpts<TMeta>): ApiBuilder<TMeta>;
|
|
165
168
|
declare const os: ApiBuilder<Record<never, never>>;
|
|
166
169
|
|
|
167
|
-
|
|
168
|
-
|
|
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>;
|
|
170
|
+
interface ValidationErrorOptions extends ErrorOptions {
|
|
171
|
+
message: string;
|
|
172
|
+
issues: readonly SchemaIssue[];
|
|
189
173
|
/**
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
174
|
+
* @todo require this field in v2
|
|
193
175
|
*/
|
|
194
|
-
|
|
176
|
+
data?: unknown;
|
|
195
177
|
}
|
|
196
178
|
/**
|
|
197
|
-
*
|
|
179
|
+
* This errors usually used for ORPCError.cause when the error is a validation error.
|
|
180
|
+
*
|
|
181
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
|
|
198
182
|
*/
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
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>;
|
|
183
|
+
declare class ValidationError extends Error {
|
|
184
|
+
readonly issues: readonly SchemaIssue[];
|
|
185
|
+
readonly data: unknown;
|
|
186
|
+
constructor(options: ValidationErrorOptions);
|
|
225
187
|
}
|
|
226
188
|
|
|
227
|
-
interface
|
|
228
|
-
|
|
229
|
-
|
|
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>>;
|
|
189
|
+
interface EventIteratorSchemaDetails {
|
|
190
|
+
yields: AnySchema;
|
|
191
|
+
returns?: AnySchema;
|
|
281
192
|
}
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
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>;
|
|
193
|
+
/**
|
|
194
|
+
* Define schema for an event iterator.
|
|
195
|
+
*
|
|
196
|
+
* @see {@link https://orpc.unnoq.com/docs/event-iterator#validate-event-iterator Validate Event Iterator Docs}
|
|
197
|
+
*/
|
|
198
|
+
declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorClass<TYieldOut, TReturnOut, void>>;
|
|
199
|
+
declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
|
|
295
200
|
|
|
296
201
|
declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
|
|
297
202
|
declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
|
|
@@ -300,10 +205,6 @@ declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: reado
|
|
|
300
205
|
declare function addMiddleware(middlewares: readonly AnyMiddleware[], addition: AnyMiddleware): AnyMiddleware[];
|
|
301
206
|
|
|
302
207
|
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
208
|
/**
|
|
308
209
|
* Directly call a procedure without creating a client.
|
|
309
210
|
*
|
|
@@ -314,9 +215,9 @@ declare function createContractedProcedure(procedure: AnyProcedure, contract: An
|
|
|
314
215
|
* ```
|
|
315
216
|
*
|
|
316
217
|
*/
|
|
317
|
-
declare function call<TInitialContext extends Context, TSchemas extends Schemas,
|
|
218
|
+
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
219
|
|
|
319
|
-
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer USchemas,
|
|
220
|
+
type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer USchemas, any> ? ProcedureClient<TClientContext, USchemas> : {
|
|
320
221
|
[K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;
|
|
321
222
|
};
|
|
322
223
|
/**
|
|
@@ -324,10 +225,31 @@ type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContex
|
|
|
324
225
|
*
|
|
325
226
|
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
326
227
|
*/
|
|
327
|
-
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>,
|
|
228
|
+
declare function createRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, TClientContext>>): RouterClient<T, TClientContext>;
|
|
229
|
+
|
|
230
|
+
declare function isSchemaIssue(issue: unknown): issue is SchemaIssue;
|
|
328
231
|
|
|
329
|
-
|
|
330
|
-
declare
|
|
232
|
+
type HTTPEndpoint = `${HTTPMethod} ${HTTPPath}`;
|
|
233
|
+
declare const endpointRegex: RegExp;
|
|
234
|
+
/**
|
|
235
|
+
* @internal
|
|
236
|
+
*/
|
|
237
|
+
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
|
238
|
+
/**
|
|
239
|
+
* @internal
|
|
240
|
+
*/
|
|
241
|
+
declare function getDynamicParams(path: HTTPPath | undefined): {
|
|
242
|
+
raw: string;
|
|
243
|
+
name: string;
|
|
244
|
+
}[] | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* @internal
|
|
247
|
+
*/
|
|
248
|
+
declare function parseEndpointDefinition(stringsOrEndpoint: TemplateStringsArray | HTTPEndpoint, values: AnyShape[] | [AnySchema | AnyShape] | []): {
|
|
249
|
+
method: HTTPMethod;
|
|
250
|
+
path: HTTPPath;
|
|
251
|
+
pathSchema: AnySchema;
|
|
252
|
+
};
|
|
331
253
|
|
|
332
|
-
export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, BuilderWithMiddlewares, Context,
|
|
333
|
-
export type { ApiBuilder, BuilderDef,
|
|
254
|
+
export { AnyMiddleware, AnyProcedure, AnyRouter, AnySchema, AnyShape, BuildContextWithAuth, Builder, BuilderWithMiddlewares, Context, Contract, ContractDef, DecoratedProcedure, EnhanceRouterOptions, EnhancedRouter, InferHandlerInputs, InferProcedureClientInputs, InferRouterInitialContext, InferSchemaInput, InferSchemaOutput, InitialSchemas, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, MergedSchemas, Meta, Middleware, Procedure, ProcedureBuilder, ProcedureHandler, Router, Schema, SchemaIssue, Schemas, UnionToIntersection, ValidationError, WrapShape, addMiddleware, call, createApiBuilder, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, endpointRegex, eventIterator, getDynamicParams, getEventIteratorSchemaDetails, isSchemaIssue, isStartWithMiddlewares, mergeMiddlewares, os, parseEndpointDefinition, standardizeHTTPPath };
|
|
255
|
+
export type { ApiBuilder, BuilderDef, CreateProcedureClientOptions, DecoratedMiddleware, EventIteratorSchemaDetails, HTTPEndpoint, ProcedureClient, RouterBuilder, RouterClient, ValidationErrorOptions };
|