@orpc/server 0.0.0-next.3b1dac3 → 0.0.0-next.3b7800f
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 -21
- 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 +108 -10
- package/dist/adapters/fetch/index.d.ts +108 -10
- package/dist/adapters/fetch/index.mjs +178 -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 +86 -21
- package/dist/adapters/node/index.d.ts +86 -21
- package/dist/adapters/node/index.mjs +144 -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 +634 -95
- package/dist/index.d.ts +634 -95
- package/dist/index.mjs +193 -37
- package/dist/plugins/index.d.mts +157 -19
- package/dist/plugins/index.d.ts +157 -19
- package/dist/plugins/index.mjs +199 -17
- 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.BFBhsdJr.mjs → server.B_fj3X5m.mjs} +135 -72
- package/dist/shared/server.Bmh5xd4n.d.ts +74 -0
- package/dist/shared/{server.CPteJIPP.d.mts → server.CYNGeoCm.d.mts} +75 -24
- package/dist/shared/{server.CPteJIPP.d.ts → server.CYNGeoCm.d.ts} +75 -24
- 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.3cSam35R.mjs +0 -158
- package/dist/shared/server.BZRSVRDu.d.ts +0 -77
- package/dist/shared/server.CjB_m7jG.mjs +0 -28
- package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
- package/dist/shared/server.iM8li30u.d.mts +0 -77
@@ -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,25 +22,34 @@ function unlazy(lazied) {
|
|
21
22
|
return isLazy(lazied) ? lazied[LAZY_SYMBOL].loader() : Promise.resolve({ default: lazied });
|
22
23
|
}
|
23
24
|
|
24
|
-
function
|
25
|
-
|
25
|
+
function isStartWithMiddlewares(middlewares, compare) {
|
26
|
+
if (compare.length > middlewares.length) {
|
27
|
+
return false;
|
28
|
+
}
|
26
29
|
for (let i = 0; i < middlewares.length; i++) {
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
+
if (compare[i] === void 0) {
|
31
|
+
return true;
|
32
|
+
}
|
33
|
+
if (middlewares[i] !== compare[i]) {
|
34
|
+
return false;
|
30
35
|
}
|
31
|
-
min = index + 1;
|
32
36
|
}
|
33
|
-
return
|
37
|
+
return true;
|
34
38
|
}
|
35
|
-
function mergeMiddlewares(first, second) {
|
36
|
-
|
39
|
+
function mergeMiddlewares(first, second, options) {
|
40
|
+
if (options.dedupeLeading && isStartWithMiddlewares(second, first)) {
|
41
|
+
return second;
|
42
|
+
}
|
43
|
+
return [...first, ...second];
|
37
44
|
}
|
38
45
|
function addMiddleware(middlewares, addition) {
|
39
46
|
return [...middlewares, addition];
|
40
47
|
}
|
41
48
|
|
42
49
|
class Procedure {
|
50
|
+
/**
|
51
|
+
* This property holds the defined options.
|
52
|
+
*/
|
43
53
|
"~orpc";
|
44
54
|
constructor(def) {
|
45
55
|
this["~orpc"] = def;
|
@@ -52,20 +62,25 @@ function isProcedure(item) {
|
|
52
62
|
return isContractProcedure(item) && "middlewares" in item["~orpc"] && "inputValidationIndex" in item["~orpc"] && "outputValidationIndex" in item["~orpc"] && "handler" in item["~orpc"];
|
53
63
|
}
|
54
64
|
|
65
|
+
function mergeCurrentContext(context, other) {
|
66
|
+
return { ...context, ...other };
|
67
|
+
}
|
68
|
+
|
55
69
|
function createORPCErrorConstructorMap(errors) {
|
56
70
|
const proxy = new Proxy(errors, {
|
57
71
|
get(target, code) {
|
58
72
|
if (typeof code !== "string") {
|
59
73
|
return Reflect.get(target, code);
|
60
74
|
}
|
61
|
-
const item = (...
|
75
|
+
const item = (...rest) => {
|
76
|
+
const options = resolveMaybeOptionalOptions(rest);
|
62
77
|
const config = errors[code];
|
63
78
|
return new ORPCError(code, {
|
64
79
|
defined: Boolean(config),
|
65
80
|
status: config?.status,
|
66
|
-
message: options
|
67
|
-
data: options
|
68
|
-
cause: options
|
81
|
+
message: options.message ?? config?.message,
|
82
|
+
data: options.data,
|
83
|
+
cause: options.cause
|
69
84
|
});
|
70
85
|
};
|
71
86
|
return item;
|
@@ -93,31 +108,48 @@ function middlewareOutputFn(output) {
|
|
93
108
|
return { output, context: {} };
|
94
109
|
}
|
95
110
|
|
96
|
-
function createProcedureClient(lazyableProcedure, ...
|
111
|
+
function createProcedureClient(lazyableProcedure, ...rest) {
|
112
|
+
const options = resolveMaybeOptionalOptions(rest);
|
97
113
|
return async (...[input, callerOptions]) => {
|
98
|
-
const path = options
|
114
|
+
const path = toArray(options.path);
|
99
115
|
const { default: procedure } = await unlazy(lazyableProcedure);
|
100
116
|
const clientContext = callerOptions?.context ?? {};
|
101
|
-
const context = await value(options
|
117
|
+
const context = await value(options.context ?? {}, clientContext);
|
102
118
|
const errors = createORPCErrorConstructorMap(procedure["~orpc"].errorMap);
|
103
119
|
try {
|
104
|
-
|
105
|
-
|
106
|
-
{
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
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
|
+
}
|
117
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;
|
118
150
|
} catch (e) {
|
119
151
|
if (!(e instanceof ORPCError)) {
|
120
|
-
throw
|
152
|
+
throw e;
|
121
153
|
}
|
122
154
|
const validated = await validateORPCError(procedure["~orpc"].errorMap, e);
|
123
155
|
throw validated;
|
@@ -129,58 +161,80 @@ async function validateInput(procedure, input) {
|
|
129
161
|
if (!schema) {
|
130
162
|
return input;
|
131
163
|
}
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
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
|
+
);
|
143
180
|
}
|
144
181
|
async function validateOutput(procedure, output) {
|
145
182
|
const schema = procedure["~orpc"].outputSchema;
|
146
183
|
if (!schema) {
|
147
184
|
return output;
|
148
185
|
}
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
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
|
+
);
|
157
199
|
}
|
158
200
|
async function executeProcedureInternal(procedure, options) {
|
159
201
|
const middlewares = procedure["~orpc"].middlewares;
|
160
202
|
const inputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].inputValidationIndex), middlewares.length);
|
161
203
|
const outputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].outputValidationIndex), middlewares.length);
|
162
|
-
|
163
|
-
|
164
|
-
let currentInput = options.input;
|
165
|
-
const next = async (...[nextOptions]) => {
|
166
|
-
const index = currentIndex;
|
167
|
-
currentIndex += 1;
|
168
|
-
currentContext = { ...currentContext, ...nextOptions?.context };
|
204
|
+
const next = async (index, context, input) => {
|
205
|
+
let currentInput = input;
|
169
206
|
if (index === inputValidationIndex) {
|
170
207
|
currentInput = await validateInput(procedure, currentInput);
|
171
208
|
}
|
172
209
|
const mid = middlewares[index];
|
173
|
-
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
|
+
);
|
174
232
|
if (index === outputValidationIndex) {
|
175
|
-
|
176
|
-
return {
|
177
|
-
...result,
|
178
|
-
output: validatedOutput
|
179
|
-
};
|
233
|
+
return await validateOutput(procedure, output);
|
180
234
|
}
|
181
|
-
return
|
235
|
+
return output;
|
182
236
|
};
|
183
|
-
return (
|
237
|
+
return next(0, options.context, options.input);
|
184
238
|
}
|
185
239
|
|
186
240
|
const HIDDEN_ROUTER_CONTRACT_SYMBOL = Symbol("ORPC_HIDDEN_ROUTER_CONTRACT");
|
@@ -250,7 +304,7 @@ function enhanceRouter(router, options) {
|
|
250
304
|
return accessible;
|
251
305
|
}
|
252
306
|
if (isProcedure(router)) {
|
253
|
-
const newMiddlewares = mergeMiddlewares(options.middlewares, router["~orpc"].middlewares);
|
307
|
+
const newMiddlewares = mergeMiddlewares(options.middlewares, router["~orpc"].middlewares, { dedupeLeading: options.dedupeLeadingMiddlewares });
|
254
308
|
const newMiddlewareAdded = newMiddlewares.length - router["~orpc"].middlewares.length;
|
255
309
|
const enhanced2 = new Procedure({
|
256
310
|
...router["~orpc"],
|
@@ -311,6 +365,18 @@ async function resolveContractProcedures(options, callback) {
|
|
311
365
|
}
|
312
366
|
}
|
313
367
|
}
|
368
|
+
async function unlazyRouter(router) {
|
369
|
+
if (isProcedure(router)) {
|
370
|
+
return router;
|
371
|
+
}
|
372
|
+
const unlazied = {};
|
373
|
+
for (const key in router) {
|
374
|
+
const item = router[key];
|
375
|
+
const { default: unlaziedRouter } = await unlazy(item);
|
376
|
+
unlazied[key] = await unlazyRouter(unlaziedRouter);
|
377
|
+
}
|
378
|
+
return unlazied;
|
379
|
+
}
|
314
380
|
|
315
381
|
function createAssertedLazyProcedure(lazied) {
|
316
382
|
const lazyProcedure = lazy(async () => {
|
@@ -335,11 +401,8 @@ function createContractedProcedure(procedure, contract) {
|
|
335
401
|
});
|
336
402
|
}
|
337
403
|
function call(procedure, input, ...rest) {
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
function toHttpPath(path) {
|
342
|
-
return `/${path.map(encodeURIComponent).join("/")}`;
|
404
|
+
const options = resolveMaybeOptionalOptions(rest);
|
405
|
+
return createProcedureClient(procedure, options)(input, options);
|
343
406
|
}
|
344
407
|
|
345
|
-
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,19 +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<
|
6
|
-
type
|
7
|
-
|
8
|
-
|
9
|
-
[K in keyof T]: IsNever<T[K]>;
|
10
|
-
}[keyof T] ? never : unknown;
|
5
|
+
type Context = Record<PropertyKey, any>;
|
6
|
+
type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
|
7
|
+
type MergedCurrentContext<T extends Context, U extends Context> = Omit<T, keyof U> & U;
|
8
|
+
declare function mergeCurrentContext<T extends Context, U extends Context>(context: T, other: U): MergedCurrentContext<T, U>;
|
11
9
|
|
12
10
|
type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
|
13
11
|
type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
|
14
12
|
type ORPCErrorConstructorMap<T extends ErrorMap> = {
|
15
13
|
[K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
|
16
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>>;
|
17
17
|
|
18
18
|
declare const LAZY_SYMBOL: unique symbol;
|
19
19
|
interface LazyMeta {
|
@@ -28,6 +28,11 @@ interface Lazy<T> {
|
|
28
28
|
};
|
29
29
|
}
|
30
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
|
+
*/
|
31
36
|
declare function lazy<T>(loader: () => Promise<{
|
32
37
|
default: T;
|
33
38
|
}>, meta?: LazyMeta): Lazy<T>;
|
@@ -51,12 +56,20 @@ interface ProcedureHandler<TCurrentContext extends Context, TInput, THandlerOutp
|
|
51
56
|
}
|
52
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> {
|
53
58
|
__initialContext?: (type: TInitialContext) => unknown;
|
54
|
-
middlewares: AnyMiddleware[];
|
59
|
+
middlewares: readonly AnyMiddleware[];
|
55
60
|
inputValidationIndex: number;
|
56
61
|
outputValidationIndex: number;
|
57
62
|
handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
|
58
63
|
}
|
64
|
+
/**
|
65
|
+
* This class represents a procedure.
|
66
|
+
*
|
67
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
68
|
+
*/
|
59
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
|
+
*/
|
60
73
|
'~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
61
74
|
constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
62
75
|
}
|
@@ -72,8 +85,8 @@ type MiddlewareNextFnOptions<TOutContext extends Context> = Record<never, never>
|
|
72
85
|
} : {
|
73
86
|
context: TOutContext;
|
74
87
|
};
|
75
|
-
interface MiddlewareNextFn<
|
76
|
-
<U extends Context
|
88
|
+
interface MiddlewareNextFn<TOutput> {
|
89
|
+
<U extends Context = Record<never, never>>(...rest: MaybeOptionalOptions<MiddlewareNextFnOptions<U>>): MiddlewareResult<U, TOutput>;
|
77
90
|
}
|
78
91
|
interface MiddlewareOutputFn<TOutput> {
|
79
92
|
(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
|
@@ -84,9 +97,14 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
|
|
84
97
|
procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
|
85
98
|
signal?: AbortSignal;
|
86
99
|
lastEventId: string | undefined;
|
87
|
-
next: MiddlewareNextFn<
|
100
|
+
next: MiddlewareNextFn<TOutput>;
|
88
101
|
errors: TErrorConstructorMap;
|
89
102
|
}
|
103
|
+
/**
|
104
|
+
* A function that represents a middleware.
|
105
|
+
*
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
107
|
+
*/
|
90
108
|
interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
|
91
109
|
(options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
|
92
110
|
}
|
@@ -97,47 +115,80 @@ interface MapInputMiddleware<TInput, TMappedInput> {
|
|
97
115
|
declare function middlewareOutputFn<TOutput>(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
|
98
116
|
|
99
117
|
type ProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
100
|
-
interface ProcedureClientInterceptorOptions<TInitialContext extends Context,
|
118
|
+
interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
101
119
|
context: TInitialContext;
|
102
|
-
input:
|
120
|
+
input: unknown;
|
103
121
|
errors: ORPCErrorConstructorMap<TErrorMap>;
|
104
122
|
path: readonly string[];
|
105
123
|
procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
|
106
124
|
signal?: AbortSignal;
|
107
125
|
lastEventId: string | undefined;
|
108
126
|
}
|
109
|
-
|
110
|
-
* Options for creating a procedure caller with comprehensive type safety
|
111
|
-
*/
|
112
|
-
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> = {
|
113
128
|
/**
|
114
129
|
* This is helpful for logging and analytics.
|
115
130
|
*/
|
116
131
|
path?: readonly string[];
|
117
|
-
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext,
|
132
|
+
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
|
118
133
|
} & (Record<never, never> extends TInitialContext ? {
|
119
|
-
context?: Value<TInitialContext
|
134
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
120
135
|
} : {
|
121
|
-
context: Value<TInitialContext
|
136
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
122
137
|
});
|
123
|
-
|
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>;
|
124
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
|
+
*/
|
125
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> : {
|
126
152
|
[K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
|
127
153
|
};
|
128
154
|
type AnyRouter = Router<any, any>;
|
129
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
|
+
*/
|
130
162
|
type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
|
131
163
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
|
132
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
|
+
*/
|
133
171
|
type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
|
134
172
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
|
135
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
|
+
*/
|
136
180
|
type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
137
181
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
|
138
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
|
+
*/
|
139
189
|
type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
140
190
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
|
141
191
|
};
|
142
192
|
|
143
|
-
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 };
|