@orpc/server 0.0.0-next.d452413 → 0.0.0-next.d53d856
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -23
- package/dist/adapters/aws-lambda/index.d.mts +46 -0
- package/dist/adapters/aws-lambda/index.d.ts +46 -0
- package/dist/adapters/aws-lambda/index.mjs +42 -0
- package/dist/adapters/bun-ws/index.d.mts +36 -0
- package/dist/adapters/bun-ws/index.d.ts +36 -0
- package/dist/adapters/bun-ws/index.mjs +47 -0
- package/dist/adapters/crossws/index.d.mts +33 -0
- package/dist/adapters/crossws/index.d.ts +33 -0
- package/dist/adapters/crossws/index.mjs +45 -0
- package/dist/adapters/fetch/index.d.mts +107 -10
- package/dist/adapters/fetch/index.d.ts +107 -10
- package/dist/adapters/fetch/index.mjs +171 -8
- package/dist/adapters/message-port/index.d.mts +31 -0
- package/dist/adapters/message-port/index.d.ts +31 -0
- package/dist/adapters/message-port/index.mjs +39 -0
- package/dist/adapters/node/index.d.mts +85 -21
- package/dist/adapters/node/index.d.ts +85 -21
- package/dist/adapters/node/index.mjs +145 -23
- package/dist/adapters/standard/index.d.mts +11 -15
- package/dist/adapters/standard/index.d.ts +11 -15
- package/dist/adapters/standard/index.mjs +5 -3
- package/dist/adapters/standard-peer/index.d.mts +18 -0
- package/dist/adapters/standard-peer/index.d.ts +18 -0
- package/dist/adapters/standard-peer/index.mjs +7 -0
- package/dist/adapters/websocket/index.d.mts +54 -0
- package/dist/adapters/websocket/index.d.ts +54 -0
- package/dist/adapters/websocket/index.mjs +67 -0
- package/dist/adapters/ws/index.d.mts +31 -0
- package/dist/adapters/ws/index.d.ts +31 -0
- package/dist/adapters/ws/index.mjs +37 -0
- package/dist/helpers/index.d.mts +134 -0
- package/dist/helpers/index.d.ts +134 -0
- package/dist/helpers/index.mjs +188 -0
- package/dist/hibernation/index.d.mts +44 -0
- package/dist/hibernation/index.d.ts +44 -0
- package/dist/hibernation/index.mjs +65 -0
- package/dist/index.d.mts +622 -88
- package/dist/index.d.ts +622 -88
- package/dist/index.mjs +180 -34
- package/dist/plugins/index.d.mts +154 -16
- package/dist/plugins/index.d.ts +154 -16
- package/dist/plugins/index.mjs +198 -16
- package/dist/shared/server.B7b2w3_i.d.ts +12 -0
- package/dist/shared/server.BEFBl-Cb.d.mts +12 -0
- package/dist/shared/server.BU4WI18A.d.mts +32 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/{server.CMrS28Go.mjs → server.B_fj3X5m.mjs} +126 -64
- package/dist/shared/server.Bmh5xd4n.d.ts +74 -0
- package/dist/shared/{server.Zu6nd6jA.d.mts → server.CYNGeoCm.d.mts} +69 -17
- package/dist/shared/{server.Zu6nd6jA.d.ts → server.CYNGeoCm.d.ts} +69 -17
- package/dist/shared/server.CYRYFTxo.mjs +219 -0
- package/dist/shared/server.D0H-iaY3.d.ts +32 -0
- package/dist/shared/server.DZ5BIITo.mjs +9 -0
- package/dist/shared/server.DhJj-1X9.d.mts +42 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/dist/shared/server.gqRxT-yN.d.mts +74 -0
- package/dist/shared/server.jMTkVNIb.d.ts +42 -0
- package/package.json +71 -20
- package/dist/adapters/hono/index.d.mts +0 -19
- package/dist/adapters/hono/index.d.ts +0 -19
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -26
- package/dist/adapters/next/index.d.ts +0 -26
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.CSZRzcSW.mjs +0 -158
- package/dist/shared/server.Cq3B6PoL.mjs +0 -28
- package/dist/shared/server.Ctc1Ekur.d.mts +0 -75
- package/dist/shared/server.DyteP6Y8.d.ts +0 -75
- package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { isContractProcedure, ValidationError, mergePrefix, mergeErrorMap, enhanceRoute } from '@orpc/contract';
|
|
2
|
+
import { resolveMaybeOptionalOptions, toArray, value, runWithSpan, intercept, isAsyncIteratorObject, asyncIteratorWithSpan } from '@orpc/shared';
|
|
2
3
|
import { fallbackORPCErrorStatus, ORPCError } from '@orpc/client';
|
|
3
|
-
import {
|
|
4
|
+
import { HibernationEventIterator } from '@orpc/standard-server';
|
|
4
5
|
|
|
5
6
|
const LAZY_SYMBOL = Symbol("ORPC_LAZY_SYMBOL");
|
|
6
7
|
function lazy(loader, meta = {}) {
|
|
@@ -21,7 +22,24 @@ function unlazy(lazied) {
|
|
|
21
22
|
return isLazy(lazied) ? lazied[LAZY_SYMBOL].loader() : Promise.resolve({ default: lazied });
|
|
22
23
|
}
|
|
23
24
|
|
|
24
|
-
function
|
|
25
|
+
function isStartWithMiddlewares(middlewares, compare) {
|
|
26
|
+
if (compare.length > middlewares.length) {
|
|
27
|
+
return false;
|
|
28
|
+
}
|
|
29
|
+
for (let i = 0; i < middlewares.length; i++) {
|
|
30
|
+
if (compare[i] === void 0) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
if (middlewares[i] !== compare[i]) {
|
|
34
|
+
return false;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
function mergeMiddlewares(first, second, options) {
|
|
40
|
+
if (options.dedupeLeading && isStartWithMiddlewares(second, first)) {
|
|
41
|
+
return second;
|
|
42
|
+
}
|
|
25
43
|
return [...first, ...second];
|
|
26
44
|
}
|
|
27
45
|
function addMiddleware(middlewares, addition) {
|
|
@@ -29,6 +47,9 @@ function addMiddleware(middlewares, addition) {
|
|
|
29
47
|
}
|
|
30
48
|
|
|
31
49
|
class Procedure {
|
|
50
|
+
/**
|
|
51
|
+
* This property holds the defined options.
|
|
52
|
+
*/
|
|
32
53
|
"~orpc";
|
|
33
54
|
constructor(def) {
|
|
34
55
|
this["~orpc"] = def;
|
|
@@ -41,20 +62,25 @@ function isProcedure(item) {
|
|
|
41
62
|
return isContractProcedure(item) && "middlewares" in item["~orpc"] && "inputValidationIndex" in item["~orpc"] && "outputValidationIndex" in item["~orpc"] && "handler" in item["~orpc"];
|
|
42
63
|
}
|
|
43
64
|
|
|
65
|
+
function mergeCurrentContext(context, other) {
|
|
66
|
+
return { ...context, ...other };
|
|
67
|
+
}
|
|
68
|
+
|
|
44
69
|
function createORPCErrorConstructorMap(errors) {
|
|
45
70
|
const proxy = new Proxy(errors, {
|
|
46
71
|
get(target, code) {
|
|
47
72
|
if (typeof code !== "string") {
|
|
48
73
|
return Reflect.get(target, code);
|
|
49
74
|
}
|
|
50
|
-
const item = (...
|
|
75
|
+
const item = (...rest) => {
|
|
76
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
51
77
|
const config = errors[code];
|
|
52
78
|
return new ORPCError(code, {
|
|
53
79
|
defined: Boolean(config),
|
|
54
80
|
status: config?.status,
|
|
55
|
-
message: options
|
|
56
|
-
data: options
|
|
57
|
-
cause: options
|
|
81
|
+
message: options.message ?? config?.message,
|
|
82
|
+
data: options.data,
|
|
83
|
+
cause: options.cause
|
|
58
84
|
});
|
|
59
85
|
};
|
|
60
86
|
return item;
|
|
@@ -82,31 +108,48 @@ function middlewareOutputFn(output) {
|
|
|
82
108
|
return { output, context: {} };
|
|
83
109
|
}
|
|
84
110
|
|
|
85
|
-
function createProcedureClient(lazyableProcedure, ...
|
|
111
|
+
function createProcedureClient(lazyableProcedure, ...rest) {
|
|
112
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
86
113
|
return async (...[input, callerOptions]) => {
|
|
87
|
-
const path = options
|
|
114
|
+
const path = toArray(options.path);
|
|
88
115
|
const { default: procedure } = await unlazy(lazyableProcedure);
|
|
89
116
|
const clientContext = callerOptions?.context ?? {};
|
|
90
|
-
const context = await value(options
|
|
117
|
+
const context = await value(options.context ?? {}, clientContext);
|
|
91
118
|
const errors = createORPCErrorConstructorMap(procedure["~orpc"].errorMap);
|
|
92
119
|
try {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
{
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
120
|
+
const output = await runWithSpan(
|
|
121
|
+
{ name: "call_procedure", signal: callerOptions?.signal },
|
|
122
|
+
(span) => {
|
|
123
|
+
span?.setAttribute("procedure.path", [...path]);
|
|
124
|
+
return intercept(
|
|
125
|
+
toArray(options.interceptors),
|
|
126
|
+
{
|
|
127
|
+
context,
|
|
128
|
+
input,
|
|
129
|
+
// input only optional when it undefinable so we can safely cast it
|
|
130
|
+
errors,
|
|
131
|
+
path,
|
|
132
|
+
procedure,
|
|
133
|
+
signal: callerOptions?.signal,
|
|
134
|
+
lastEventId: callerOptions?.lastEventId
|
|
135
|
+
},
|
|
136
|
+
(interceptorOptions) => executeProcedureInternal(interceptorOptions.procedure, interceptorOptions)
|
|
137
|
+
);
|
|
138
|
+
}
|
|
106
139
|
);
|
|
140
|
+
if (isAsyncIteratorObject(output)) {
|
|
141
|
+
if (output instanceof HibernationEventIterator) {
|
|
142
|
+
return output;
|
|
143
|
+
}
|
|
144
|
+
return asyncIteratorWithSpan(
|
|
145
|
+
{ name: "consume_event_iterator_output", signal: callerOptions?.signal },
|
|
146
|
+
output
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
return output;
|
|
107
150
|
} catch (e) {
|
|
108
151
|
if (!(e instanceof ORPCError)) {
|
|
109
|
-
throw
|
|
152
|
+
throw e;
|
|
110
153
|
}
|
|
111
154
|
const validated = await validateORPCError(procedure["~orpc"].errorMap, e);
|
|
112
155
|
throw validated;
|
|
@@ -118,58 +161,80 @@ async function validateInput(procedure, input) {
|
|
|
118
161
|
if (!schema) {
|
|
119
162
|
return input;
|
|
120
163
|
}
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
164
|
+
return runWithSpan(
|
|
165
|
+
{ name: "validate_input" },
|
|
166
|
+
async () => {
|
|
167
|
+
const result = await schema["~standard"].validate(input);
|
|
168
|
+
if (result.issues) {
|
|
169
|
+
throw new ORPCError("BAD_REQUEST", {
|
|
170
|
+
message: "Input validation failed",
|
|
171
|
+
data: {
|
|
172
|
+
issues: result.issues
|
|
173
|
+
},
|
|
174
|
+
cause: new ValidationError({ message: "Input validation failed", issues: result.issues })
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
return result.value;
|
|
178
|
+
}
|
|
179
|
+
);
|
|
132
180
|
}
|
|
133
181
|
async function validateOutput(procedure, output) {
|
|
134
182
|
const schema = procedure["~orpc"].outputSchema;
|
|
135
183
|
if (!schema) {
|
|
136
184
|
return output;
|
|
137
185
|
}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
186
|
+
return runWithSpan(
|
|
187
|
+
{ name: "validate_output" },
|
|
188
|
+
async () => {
|
|
189
|
+
const result = await schema["~standard"].validate(output);
|
|
190
|
+
if (result.issues) {
|
|
191
|
+
throw new ORPCError("INTERNAL_SERVER_ERROR", {
|
|
192
|
+
message: "Output validation failed",
|
|
193
|
+
cause: new ValidationError({ message: "Output validation failed", issues: result.issues })
|
|
194
|
+
});
|
|
195
|
+
}
|
|
196
|
+
return result.value;
|
|
197
|
+
}
|
|
198
|
+
);
|
|
146
199
|
}
|
|
147
200
|
async function executeProcedureInternal(procedure, options) {
|
|
148
201
|
const middlewares = procedure["~orpc"].middlewares;
|
|
149
202
|
const inputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].inputValidationIndex), middlewares.length);
|
|
150
203
|
const outputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].outputValidationIndex), middlewares.length);
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
let currentInput = options.input;
|
|
154
|
-
const next = async (...[nextOptions]) => {
|
|
155
|
-
const index = currentIndex;
|
|
156
|
-
currentIndex += 1;
|
|
157
|
-
currentContext = { ...currentContext, ...nextOptions?.context };
|
|
204
|
+
const next = async (index, context, input) => {
|
|
205
|
+
let currentInput = input;
|
|
158
206
|
if (index === inputValidationIndex) {
|
|
159
207
|
currentInput = await validateInput(procedure, currentInput);
|
|
160
208
|
}
|
|
161
209
|
const mid = middlewares[index];
|
|
162
|
-
const
|
|
210
|
+
const output = mid ? await runWithSpan(
|
|
211
|
+
{ name: `middleware.${mid.name}`, signal: options.signal },
|
|
212
|
+
async (span) => {
|
|
213
|
+
span?.setAttribute("middleware.index", index);
|
|
214
|
+
span?.setAttribute("middleware.name", mid.name);
|
|
215
|
+
const result = await mid({
|
|
216
|
+
...options,
|
|
217
|
+
context,
|
|
218
|
+
next: async (...[nextOptions]) => {
|
|
219
|
+
const nextContext = nextOptions?.context ?? {};
|
|
220
|
+
return {
|
|
221
|
+
output: await next(index + 1, mergeCurrentContext(context, nextContext), currentInput),
|
|
222
|
+
context: nextContext
|
|
223
|
+
};
|
|
224
|
+
}
|
|
225
|
+
}, currentInput, middlewareOutputFn);
|
|
226
|
+
return result.output;
|
|
227
|
+
}
|
|
228
|
+
) : await runWithSpan(
|
|
229
|
+
{ name: "handler", signal: options.signal },
|
|
230
|
+
() => procedure["~orpc"].handler({ ...options, context, input: currentInput })
|
|
231
|
+
);
|
|
163
232
|
if (index === outputValidationIndex) {
|
|
164
|
-
|
|
165
|
-
return {
|
|
166
|
-
...result,
|
|
167
|
-
output: validatedOutput
|
|
168
|
-
};
|
|
233
|
+
return await validateOutput(procedure, output);
|
|
169
234
|
}
|
|
170
|
-
return
|
|
235
|
+
return output;
|
|
171
236
|
};
|
|
172
|
-
return (
|
|
237
|
+
return next(0, options.context, options.input);
|
|
173
238
|
}
|
|
174
239
|
|
|
175
240
|
const HIDDEN_ROUTER_CONTRACT_SYMBOL = Symbol("ORPC_HIDDEN_ROUTER_CONTRACT");
|
|
@@ -239,7 +304,7 @@ function enhanceRouter(router, options) {
|
|
|
239
304
|
return accessible;
|
|
240
305
|
}
|
|
241
306
|
if (isProcedure(router)) {
|
|
242
|
-
const newMiddlewares = mergeMiddlewares(options.middlewares, router["~orpc"].middlewares);
|
|
307
|
+
const newMiddlewares = mergeMiddlewares(options.middlewares, router["~orpc"].middlewares, { dedupeLeading: options.dedupeLeadingMiddlewares });
|
|
243
308
|
const newMiddlewareAdded = newMiddlewares.length - router["~orpc"].middlewares.length;
|
|
244
309
|
const enhanced2 = new Procedure({
|
|
245
310
|
...router["~orpc"],
|
|
@@ -336,11 +401,8 @@ function createContractedProcedure(procedure, contract) {
|
|
|
336
401
|
});
|
|
337
402
|
}
|
|
338
403
|
function call(procedure, input, ...rest) {
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
function toHttpPath(path) {
|
|
343
|
-
return `/${path.map(encodeURIComponent).join("/")}`;
|
|
404
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
405
|
+
return createProcedureClient(procedure, options)(input, options);
|
|
344
406
|
}
|
|
345
407
|
|
|
346
|
-
export { LAZY_SYMBOL as L, Procedure as P,
|
|
408
|
+
export { LAZY_SYMBOL as L, Procedure as P, createContractedProcedure as a, addMiddleware as b, createProcedureClient as c, isLazy as d, enhanceRouter as e, createAssertedLazyProcedure as f, getRouter as g, createORPCErrorConstructorMap as h, isProcedure as i, getLazyMeta as j, middlewareOutputFn as k, lazy as l, mergeCurrentContext as m, isStartWithMiddlewares as n, mergeMiddlewares as o, call as p, getHiddenRouterContract as q, createAccessibleLazyRouter as r, setHiddenRouterContract as s, traverseContractProcedures as t, unlazy as u, validateORPCError as v, resolveContractProcedures as w, unlazyRouter as x };
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { HTTPPath, ORPCError } from '@orpc/client';
|
|
2
|
+
import { Meta } from '@orpc/contract';
|
|
3
|
+
import { Interceptor } from '@orpc/shared';
|
|
4
|
+
import { StandardResponse, StandardLazyRequest } from '@orpc/standard-server';
|
|
5
|
+
import { C as Context, R as Router, b as AnyRouter, A as AnyProcedure, d as ProcedureClientInterceptorOptions } from './server.CYNGeoCm.js';
|
|
6
|
+
|
|
7
|
+
interface StandardHandlerPlugin<T extends Context> {
|
|
8
|
+
order?: number;
|
|
9
|
+
init?(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
|
|
10
|
+
}
|
|
11
|
+
declare class CompositeStandardHandlerPlugin<T extends Context, TPlugin extends StandardHandlerPlugin<T>> implements StandardHandlerPlugin<T> {
|
|
12
|
+
protected readonly plugins: TPlugin[];
|
|
13
|
+
constructor(plugins?: readonly TPlugin[]);
|
|
14
|
+
init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
type StandardParams = Record<string, string>;
|
|
18
|
+
type StandardMatchResult = {
|
|
19
|
+
path: readonly string[];
|
|
20
|
+
procedure: AnyProcedure;
|
|
21
|
+
params?: StandardParams;
|
|
22
|
+
} | undefined;
|
|
23
|
+
interface StandardMatcher {
|
|
24
|
+
init(router: AnyRouter): void;
|
|
25
|
+
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
|
26
|
+
}
|
|
27
|
+
interface StandardCodec {
|
|
28
|
+
encode(output: unknown, procedure: AnyProcedure): StandardResponse;
|
|
29
|
+
encodeError(error: ORPCError<any, any>): StandardResponse;
|
|
30
|
+
decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
interface StandardHandleOptions<T extends Context> {
|
|
34
|
+
prefix?: HTTPPath;
|
|
35
|
+
context: T;
|
|
36
|
+
}
|
|
37
|
+
type StandardHandleResult = {
|
|
38
|
+
matched: true;
|
|
39
|
+
response: StandardResponse;
|
|
40
|
+
} | {
|
|
41
|
+
matched: false;
|
|
42
|
+
response: undefined;
|
|
43
|
+
};
|
|
44
|
+
interface StandardHandlerInterceptorOptions<T extends Context> extends StandardHandleOptions<T> {
|
|
45
|
+
request: StandardLazyRequest;
|
|
46
|
+
}
|
|
47
|
+
interface StandardHandlerOptions<TContext extends Context> {
|
|
48
|
+
plugins?: StandardHandlerPlugin<TContext>[];
|
|
49
|
+
/**
|
|
50
|
+
* Interceptors at the request level, helpful when you want catch errors
|
|
51
|
+
*/
|
|
52
|
+
interceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, Promise<StandardHandleResult>>[];
|
|
53
|
+
/**
|
|
54
|
+
* Interceptors at the root level, helpful when you want override the request/response
|
|
55
|
+
*/
|
|
56
|
+
rootInterceptors?: Interceptor<StandardHandlerInterceptorOptions<TContext>, Promise<StandardHandleResult>>[];
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* Interceptors for procedure client.
|
|
60
|
+
*/
|
|
61
|
+
clientInterceptors?: Interceptor<ProcedureClientInterceptorOptions<TContext, Record<never, never>, Meta>, Promise<unknown>>[];
|
|
62
|
+
}
|
|
63
|
+
declare class StandardHandler<T extends Context> {
|
|
64
|
+
private readonly matcher;
|
|
65
|
+
private readonly codec;
|
|
66
|
+
private readonly interceptors;
|
|
67
|
+
private readonly clientInterceptors;
|
|
68
|
+
private readonly rootInterceptors;
|
|
69
|
+
constructor(router: Router<any, T>, matcher: StandardMatcher, codec: StandardCodec, options: NoInfer<StandardHandlerOptions<T>>);
|
|
70
|
+
handle(request: StandardLazyRequest, options: StandardHandleOptions<T>): Promise<StandardHandleResult>;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export { CompositeStandardHandlerPlugin as C, StandardHandler as f };
|
|
74
|
+
export type { StandardCodec as S, StandardParams as a, StandardHandleOptions as b, StandardHandleResult as c, StandardHandlerInterceptorOptions as d, StandardHandlerOptions as e, StandardHandlerPlugin as g, StandardMatchResult as h, StandardMatcher as i };
|
|
@@ -1,18 +1,19 @@
|
|
|
1
|
-
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, ClientContext, Client } from '@orpc/client';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
|
|
2
|
+
import { ErrorMap, ErrorMapItem, InferSchemaInput, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
|
|
3
|
+
import { MaybeOptionalOptions, Promisable, Interceptor, PromiseWithError, Value } from '@orpc/shared';
|
|
4
4
|
|
|
5
|
-
type Context = Record<
|
|
5
|
+
type Context = Record<PropertyKey, any>;
|
|
6
6
|
type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
|
|
7
7
|
type MergedCurrentContext<T extends Context, U extends Context> = Omit<T, keyof U> & U;
|
|
8
8
|
declare function mergeCurrentContext<T extends Context, U extends Context>(context: T, other: U): MergedCurrentContext<T, U>;
|
|
9
|
-
type ContextExtendsGuard<T extends Context, U extends Context> = T extends T & U ? unknown : never;
|
|
10
9
|
|
|
11
10
|
type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
|
|
12
11
|
type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
|
|
13
12
|
type ORPCErrorConstructorMap<T extends ErrorMap> = {
|
|
14
13
|
[K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
|
|
15
14
|
};
|
|
15
|
+
declare function createORPCErrorConstructorMap<T extends ErrorMap>(errors: T): ORPCErrorConstructorMap<T>;
|
|
16
|
+
declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
|
|
16
17
|
|
|
17
18
|
declare const LAZY_SYMBOL: unique symbol;
|
|
18
19
|
interface LazyMeta {
|
|
@@ -27,6 +28,11 @@ interface Lazy<T> {
|
|
|
27
28
|
};
|
|
28
29
|
}
|
|
29
30
|
type Lazyable<T> = T | Lazy<T>;
|
|
31
|
+
/**
|
|
32
|
+
* Creates a lazy-loaded item.
|
|
33
|
+
*
|
|
34
|
+
* @warning The `prefix` in `meta` only holds metadata and does not apply the prefix to the lazy router, use `os.prefix(...).lazy(...)` instead.
|
|
35
|
+
*/
|
|
30
36
|
declare function lazy<T>(loader: () => Promise<{
|
|
31
37
|
default: T;
|
|
32
38
|
}>, meta?: LazyMeta): Lazy<T>;
|
|
@@ -50,12 +56,20 @@ interface ProcedureHandler<TCurrentContext extends Context, TInput, THandlerOutp
|
|
|
50
56
|
}
|
|
51
57
|
interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
|
|
52
58
|
__initialContext?: (type: TInitialContext) => unknown;
|
|
53
|
-
middlewares: AnyMiddleware[];
|
|
59
|
+
middlewares: readonly AnyMiddleware[];
|
|
54
60
|
inputValidationIndex: number;
|
|
55
61
|
outputValidationIndex: number;
|
|
56
62
|
handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
|
|
57
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
* This class represents a procedure.
|
|
66
|
+
*
|
|
67
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
68
|
+
*/
|
|
58
69
|
declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
70
|
+
/**
|
|
71
|
+
* This property holds the defined options.
|
|
72
|
+
*/
|
|
59
73
|
'~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
60
74
|
constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
61
75
|
}
|
|
@@ -86,6 +100,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
|
|
|
86
100
|
next: MiddlewareNextFn<TOutput>;
|
|
87
101
|
errors: TErrorConstructorMap;
|
|
88
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* A function that represents a middleware.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
107
|
+
*/
|
|
89
108
|
interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
|
|
90
109
|
(options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
|
|
91
110
|
}
|
|
@@ -96,47 +115,80 @@ interface MapInputMiddleware<TInput, TMappedInput> {
|
|
|
96
115
|
declare function middlewareOutputFn<TOutput>(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
|
|
97
116
|
|
|
98
117
|
type ProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
99
|
-
interface ProcedureClientInterceptorOptions<TInitialContext extends Context,
|
|
118
|
+
interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
100
119
|
context: TInitialContext;
|
|
101
|
-
input:
|
|
120
|
+
input: unknown;
|
|
102
121
|
errors: ORPCErrorConstructorMap<TErrorMap>;
|
|
103
122
|
path: readonly string[];
|
|
104
123
|
procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
|
|
105
124
|
signal?: AbortSignal;
|
|
106
125
|
lastEventId: string | undefined;
|
|
107
126
|
}
|
|
108
|
-
|
|
109
|
-
* Options for creating a procedure caller with comprehensive type safety
|
|
110
|
-
*/
|
|
111
|
-
type CreateProcedureClientOptions<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
|
|
127
|
+
type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
|
|
112
128
|
/**
|
|
113
129
|
* This is helpful for logging and analytics.
|
|
114
130
|
*/
|
|
115
131
|
path?: readonly string[];
|
|
116
|
-
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext,
|
|
132
|
+
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
|
|
117
133
|
} & (Record<never, never> extends TInitialContext ? {
|
|
118
|
-
context?: Value<TInitialContext
|
|
134
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
119
135
|
} : {
|
|
120
|
-
context: Value<TInitialContext
|
|
136
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
121
137
|
});
|
|
122
|
-
|
|
138
|
+
/**
|
|
139
|
+
* Create Server-side client from a procedure.
|
|
140
|
+
*
|
|
141
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
142
|
+
*/
|
|
143
|
+
declare function createProcedureClient<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
123
144
|
|
|
145
|
+
/**
|
|
146
|
+
* Represents a router, which defines a hierarchical structure of procedures.
|
|
147
|
+
*
|
|
148
|
+
* @info A procedure is a router too.
|
|
149
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
|
|
150
|
+
*/
|
|
124
151
|
type Router<T extends AnyContractRouter, TInitialContext extends Context> = T extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? Procedure<TInitialContext, any, UInputSchema, UOutputSchema, UErrorMap, UMeta> : {
|
|
125
152
|
[K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
|
|
126
153
|
};
|
|
127
154
|
type AnyRouter = Router<any, any>;
|
|
128
155
|
type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
|
|
156
|
+
/**
|
|
157
|
+
* Infer all initial context of the router.
|
|
158
|
+
*
|
|
159
|
+
* @info A procedure is a router too.
|
|
160
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
161
|
+
*/
|
|
129
162
|
type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
|
|
130
163
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
|
|
131
164
|
};
|
|
165
|
+
/**
|
|
166
|
+
* Infer all current context of the router.
|
|
167
|
+
*
|
|
168
|
+
* @info A procedure is a router too.
|
|
169
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
170
|
+
*/
|
|
132
171
|
type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
|
|
133
172
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
|
|
134
173
|
};
|
|
174
|
+
/**
|
|
175
|
+
* Infer all router inputs
|
|
176
|
+
*
|
|
177
|
+
* @info A procedure is a router too.
|
|
178
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
179
|
+
*/
|
|
135
180
|
type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
136
181
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
|
|
137
182
|
};
|
|
183
|
+
/**
|
|
184
|
+
* Infer all router outputs
|
|
185
|
+
*
|
|
186
|
+
* @info A procedure is a router too.
|
|
187
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
188
|
+
*/
|
|
138
189
|
type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
139
190
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
|
|
140
191
|
};
|
|
141
192
|
|
|
142
|
-
export {
|
|
193
|
+
export { middlewareOutputFn as B, isProcedure as F, createProcedureClient as G, Procedure as P, mergeCurrentContext as m, createORPCErrorConstructorMap as n, LAZY_SYMBOL as o, lazy as q, isLazy as r, getLazyMeta as s, unlazy as u, validateORPCError as v };
|
|
194
|
+
export type { AnyProcedure as A, Context as C, ProcedureHandlerOptions as D, ProcedureDef as E, InferRouterInitialContexts as H, InferRouterInitialContext as I, InferRouterCurrentContexts as J, InferRouterInputs as K, Lazyable as L, MergedInitialContext as M, InferRouterOutputs as N, ORPCErrorConstructorMap as O, Router as R, AnyMiddleware as a, AnyRouter as b, Lazy as c, ProcedureClientInterceptorOptions as d, Middleware as e, MergedCurrentContext as f, MapInputMiddleware as g, CreateProcedureClientOptions as h, ProcedureClient as i, ProcedureHandler as j, ORPCErrorConstructorMapItemOptions as k, ORPCErrorConstructorMapItem as l, LazyMeta as p, MiddlewareResult as t, MiddlewareNextFnOptions as w, MiddlewareNextFn as x, MiddlewareOutputFn as y, MiddlewareOptions as z };
|