@orpc/server 0.0.0-next.b4fc1d9 → 0.0.0-next.b50e4fc
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 +150 -31
- 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/fastify/index.d.mts +53 -0
- package/dist/adapters/fastify/index.d.ts +53 -0
- package/dist/adapters/fastify/index.mjs +54 -0
- package/dist/adapters/fetch/index.d.mts +107 -11
- package/dist/adapters/fetch/index.d.ts +107 -11
- package/dist/adapters/fetch/index.mjs +179 -8
- package/dist/adapters/message-port/index.d.mts +57 -0
- package/dist/adapters/message-port/index.d.ts +57 -0
- package/dist/adapters/message-port/index.mjs +55 -0
- package/dist/adapters/node/index.d.mts +85 -22
- package/dist/adapters/node/index.d.ts +85 -22
- package/dist/adapters/node/index.mjs +144 -24
- package/dist/adapters/standard/index.d.mts +8 -13
- package/dist/adapters/standard/index.d.ts +8 -13
- 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 +56 -0
- package/dist/adapters/websocket/index.d.ts +56 -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 +149 -0
- package/dist/helpers/index.d.ts +149 -0
- package/dist/helpers/index.mjs +198 -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 +604 -78
- package/dist/index.d.ts +604 -78
- package/dist/index.mjs +168 -18
- package/dist/plugins/index.d.mts +190 -17
- package/dist/plugins/index.d.ts +190 -17
- package/dist/plugins/index.mjs +240 -15
- package/dist/shared/server.7cEtMB30.d.ts +74 -0
- package/dist/shared/server.B8gYOD5g.d.mts +12 -0
- package/dist/shared/server.BqadksTP.d.mts +74 -0
- package/dist/shared/server.Bxx6tqNe.mjs +219 -0
- package/dist/shared/server.C8_sRzQB.d.mts +42 -0
- package/dist/shared/server.ChUyt5-i.d.mts +32 -0
- package/dist/shared/server.ChyoA9XY.d.ts +42 -0
- package/dist/shared/server.DZ5BIITo.mjs +9 -0
- package/dist/shared/{server.BtxZnWJ9.mjs → server.Ds4HPpvH.mjs} +125 -90
- package/dist/shared/server.EfTOZ2Q7.d.ts +12 -0
- package/dist/shared/server.TEVCLCFC.mjs +39 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/dist/shared/{server.MZvbGc3n.d.mts → server.qKsRrdxW.d.mts} +66 -16
- package/dist/shared/{server.MZvbGc3n.d.ts → server.qKsRrdxW.d.ts} +66 -16
- package/dist/shared/server.yoEB3Fx4.d.ts +32 -0
- package/package.json +82 -23
- package/dist/adapters/hono/index.d.mts +0 -21
- package/dist/adapters/hono/index.d.ts +0 -21
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -28
- package/dist/adapters/next/index.d.ts +0 -28
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.BY9sDlwl.mjs +0 -158
- package/dist/shared/server.BqBN5WhH.d.mts +0 -8
- package/dist/shared/server.CPqNKiJp.d.ts +0 -75
- package/dist/shared/server.Dba3Iiyp.mjs +0 -12
- package/dist/shared/server.Del5OmaY.mjs +0 -29
- package/dist/shared/server.Dm3ZuTuI.d.ts +0 -8
- package/dist/shared/server.P4_D9lKb.d.mts +0 -75
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { isContractProcedure, ValidationError, mergePrefix, mergeErrorMap, enhanceRoute } from '@orpc/contract';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { isContractProcedure, validateORPCError, ValidationError, mergePrefix, mergeErrorMap, enhanceRoute } from '@orpc/contract';
|
|
2
|
+
import { resolveMaybeOptionalOptions, toArray, value, runWithSpan, intercept, isAsyncIteratorObject, overlayProxy, asyncIteratorWithSpan } from '@orpc/shared';
|
|
3
|
+
import { ORPCError, mapEventIterator } from '@orpc/client';
|
|
4
|
+
import { HibernationEventIterator } from '@orpc/standard-server';
|
|
4
5
|
|
|
5
6
|
const LAZY_SYMBOL = Symbol("ORPC_LAZY_SYMBOL");
|
|
6
7
|
function lazy(loader, meta = {}) {
|
|
@@ -46,6 +47,9 @@ function addMiddleware(middlewares, addition) {
|
|
|
46
47
|
}
|
|
47
48
|
|
|
48
49
|
class Procedure {
|
|
50
|
+
/**
|
|
51
|
+
* This property holds the defined options.
|
|
52
|
+
*/
|
|
49
53
|
"~orpc";
|
|
50
54
|
constructor(def) {
|
|
51
55
|
this["~orpc"] = def;
|
|
@@ -68,14 +72,15 @@ function createORPCErrorConstructorMap(errors) {
|
|
|
68
72
|
if (typeof code !== "string") {
|
|
69
73
|
return Reflect.get(target, code);
|
|
70
74
|
}
|
|
71
|
-
const item = (...
|
|
75
|
+
const item = (...rest) => {
|
|
76
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
72
77
|
const config = errors[code];
|
|
73
78
|
return new ORPCError(code, {
|
|
74
79
|
defined: Boolean(config),
|
|
75
80
|
status: config?.status,
|
|
76
|
-
message: options
|
|
77
|
-
data: options
|
|
78
|
-
cause: options
|
|
81
|
+
message: options.message ?? config?.message,
|
|
82
|
+
data: options.data,
|
|
83
|
+
cause: options.cause
|
|
79
84
|
});
|
|
80
85
|
};
|
|
81
86
|
return item;
|
|
@@ -83,54 +88,64 @@ function createORPCErrorConstructorMap(errors) {
|
|
|
83
88
|
});
|
|
84
89
|
return proxy;
|
|
85
90
|
}
|
|
86
|
-
async function validateORPCError(map, error) {
|
|
87
|
-
const { code, status, message, data, cause, defined } = error;
|
|
88
|
-
const config = map?.[error.code];
|
|
89
|
-
if (!config || fallbackORPCErrorStatus(error.code, config.status) !== error.status) {
|
|
90
|
-
return defined ? new ORPCError(code, { defined: false, status, message, data, cause }) : error;
|
|
91
|
-
}
|
|
92
|
-
if (!config.data) {
|
|
93
|
-
return defined ? error : new ORPCError(code, { defined: true, status, message, data, cause });
|
|
94
|
-
}
|
|
95
|
-
const validated = await config.data["~standard"].validate(error.data);
|
|
96
|
-
if (validated.issues) {
|
|
97
|
-
return defined ? new ORPCError(code, { defined: false, status, message, data, cause }) : error;
|
|
98
|
-
}
|
|
99
|
-
return new ORPCError(code, { defined: true, status, message, data: validated.value, cause });
|
|
100
|
-
}
|
|
101
91
|
|
|
102
92
|
function middlewareOutputFn(output) {
|
|
103
93
|
return { output, context: {} };
|
|
104
94
|
}
|
|
105
95
|
|
|
106
|
-
function createProcedureClient(lazyableProcedure, ...
|
|
96
|
+
function createProcedureClient(lazyableProcedure, ...rest) {
|
|
97
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
107
98
|
return async (...[input, callerOptions]) => {
|
|
108
|
-
const path = options
|
|
99
|
+
const path = toArray(options.path);
|
|
109
100
|
const { default: procedure } = await unlazy(lazyableProcedure);
|
|
110
101
|
const clientContext = callerOptions?.context ?? {};
|
|
111
|
-
const context = await value(options
|
|
102
|
+
const context = await value(options.context ?? {}, clientContext);
|
|
112
103
|
const errors = createORPCErrorConstructorMap(procedure["~orpc"].errorMap);
|
|
104
|
+
const validateError = async (e) => {
|
|
105
|
+
if (e instanceof ORPCError) {
|
|
106
|
+
return await validateORPCError(procedure["~orpc"].errorMap, e);
|
|
107
|
+
}
|
|
108
|
+
return e;
|
|
109
|
+
};
|
|
113
110
|
try {
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
{
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
111
|
+
const output = await runWithSpan(
|
|
112
|
+
{ name: "call_procedure", signal: callerOptions?.signal },
|
|
113
|
+
(span) => {
|
|
114
|
+
span?.setAttribute("procedure.path", [...path]);
|
|
115
|
+
return intercept(
|
|
116
|
+
toArray(options.interceptors),
|
|
117
|
+
{
|
|
118
|
+
context,
|
|
119
|
+
input,
|
|
120
|
+
// input only optional when it undefinable so we can safely cast it
|
|
121
|
+
errors,
|
|
122
|
+
path,
|
|
123
|
+
procedure,
|
|
124
|
+
signal: callerOptions?.signal,
|
|
125
|
+
lastEventId: callerOptions?.lastEventId
|
|
126
|
+
},
|
|
127
|
+
(interceptorOptions) => executeProcedureInternal(interceptorOptions.procedure, interceptorOptions)
|
|
128
|
+
);
|
|
129
|
+
}
|
|
127
130
|
);
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
+
if (isAsyncIteratorObject(output)) {
|
|
132
|
+
if (output instanceof HibernationEventIterator) {
|
|
133
|
+
return output;
|
|
134
|
+
}
|
|
135
|
+
return overlayProxy(output, mapEventIterator(
|
|
136
|
+
asyncIteratorWithSpan(
|
|
137
|
+
{ name: "consume_event_iterator_output", signal: callerOptions?.signal },
|
|
138
|
+
output
|
|
139
|
+
),
|
|
140
|
+
{
|
|
141
|
+
value: (v) => v,
|
|
142
|
+
error: (e) => validateError(e)
|
|
143
|
+
}
|
|
144
|
+
));
|
|
131
145
|
}
|
|
132
|
-
|
|
133
|
-
|
|
146
|
+
return output;
|
|
147
|
+
} catch (e) {
|
|
148
|
+
throw await validateError(e);
|
|
134
149
|
}
|
|
135
150
|
};
|
|
136
151
|
}
|
|
@@ -139,65 +154,88 @@ async function validateInput(procedure, input) {
|
|
|
139
154
|
if (!schema) {
|
|
140
155
|
return input;
|
|
141
156
|
}
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
157
|
+
return runWithSpan(
|
|
158
|
+
{ name: "validate_input" },
|
|
159
|
+
async () => {
|
|
160
|
+
const result = await schema["~standard"].validate(input);
|
|
161
|
+
if (result.issues) {
|
|
162
|
+
throw new ORPCError("BAD_REQUEST", {
|
|
163
|
+
message: "Input validation failed",
|
|
164
|
+
data: {
|
|
165
|
+
issues: result.issues
|
|
166
|
+
},
|
|
167
|
+
cause: new ValidationError({
|
|
168
|
+
message: "Input validation failed",
|
|
169
|
+
issues: result.issues,
|
|
170
|
+
data: input
|
|
171
|
+
})
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
return result.value;
|
|
175
|
+
}
|
|
176
|
+
);
|
|
153
177
|
}
|
|
154
178
|
async function validateOutput(procedure, output) {
|
|
155
179
|
const schema = procedure["~orpc"].outputSchema;
|
|
156
180
|
if (!schema) {
|
|
157
181
|
return output;
|
|
158
182
|
}
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
183
|
+
return runWithSpan(
|
|
184
|
+
{ name: "validate_output" },
|
|
185
|
+
async () => {
|
|
186
|
+
const result = await schema["~standard"].validate(output);
|
|
187
|
+
if (result.issues) {
|
|
188
|
+
throw new ORPCError("INTERNAL_SERVER_ERROR", {
|
|
189
|
+
message: "Output validation failed",
|
|
190
|
+
cause: new ValidationError({
|
|
191
|
+
message: "Output validation failed",
|
|
192
|
+
issues: result.issues,
|
|
193
|
+
data: output
|
|
194
|
+
})
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
return result.value;
|
|
198
|
+
}
|
|
199
|
+
);
|
|
167
200
|
}
|
|
168
201
|
async function executeProcedureInternal(procedure, options) {
|
|
169
202
|
const middlewares = procedure["~orpc"].middlewares;
|
|
170
203
|
const inputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].inputValidationIndex), middlewares.length);
|
|
171
204
|
const outputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].outputValidationIndex), middlewares.length);
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
let currentInput = options.input;
|
|
175
|
-
const next = async (...[nextOptions]) => {
|
|
176
|
-
const index = currentIndex;
|
|
177
|
-
const midContext = nextOptions?.context ?? {};
|
|
178
|
-
currentIndex += 1;
|
|
179
|
-
currentContext = mergeCurrentContext(currentContext, midContext);
|
|
205
|
+
const next = async (index, context, input) => {
|
|
206
|
+
let currentInput = input;
|
|
180
207
|
if (index === inputValidationIndex) {
|
|
181
208
|
currentInput = await validateInput(procedure, currentInput);
|
|
182
209
|
}
|
|
183
210
|
const mid = middlewares[index];
|
|
184
|
-
const
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
211
|
+
const output = mid ? await runWithSpan(
|
|
212
|
+
{ name: `middleware.${mid.name}`, signal: options.signal },
|
|
213
|
+
async (span) => {
|
|
214
|
+
span?.setAttribute("middleware.index", index);
|
|
215
|
+
span?.setAttribute("middleware.name", mid.name);
|
|
216
|
+
const result = await mid({
|
|
217
|
+
...options,
|
|
218
|
+
context,
|
|
219
|
+
next: async (...[nextOptions]) => {
|
|
220
|
+
const nextContext = nextOptions?.context ?? {};
|
|
221
|
+
return {
|
|
222
|
+
output: await next(index + 1, mergeCurrentContext(context, nextContext), currentInput),
|
|
223
|
+
context: nextContext
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
}, currentInput, middlewareOutputFn);
|
|
227
|
+
return result.output;
|
|
228
|
+
}
|
|
229
|
+
) : await runWithSpan(
|
|
230
|
+
{ name: "handler", signal: options.signal },
|
|
231
|
+
() => procedure["~orpc"].handler({ ...options, context, input: currentInput })
|
|
232
|
+
);
|
|
191
233
|
if (index === outputValidationIndex) {
|
|
192
|
-
|
|
193
|
-
return {
|
|
194
|
-
context: result.context,
|
|
195
|
-
output: validatedOutput
|
|
196
|
-
};
|
|
234
|
+
return await validateOutput(procedure, output);
|
|
197
235
|
}
|
|
198
|
-
return
|
|
236
|
+
return output;
|
|
199
237
|
};
|
|
200
|
-
return (
|
|
238
|
+
return next(0, options.context, options.input);
|
|
201
239
|
}
|
|
202
240
|
|
|
203
241
|
const HIDDEN_ROUTER_CONTRACT_SYMBOL = Symbol("ORPC_HIDDEN_ROUTER_CONTRACT");
|
|
@@ -364,11 +402,8 @@ function createContractedProcedure(procedure, contract) {
|
|
|
364
402
|
});
|
|
365
403
|
}
|
|
366
404
|
function call(procedure, input, ...rest) {
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
function toHttpPath(path) {
|
|
371
|
-
return `/${path.map(encodeURIComponent).join("/")}`;
|
|
405
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
406
|
+
return createProcedureClient(procedure, options)(input, options);
|
|
372
407
|
}
|
|
373
408
|
|
|
374
|
-
export { LAZY_SYMBOL as L, Procedure as P,
|
|
409
|
+
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, resolveContractProcedures as v, unlazyRouter as w };
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { C as Context } from './server.qKsRrdxW.js';
|
|
2
|
+
import { b as StandardHandleOptions } from './server.7cEtMB30.js';
|
|
3
|
+
|
|
4
|
+
type FriendlyStandardHandleOptions<T extends Context> = Omit<StandardHandleOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
|
5
|
+
context?: T;
|
|
6
|
+
} : {
|
|
7
|
+
context: T;
|
|
8
|
+
});
|
|
9
|
+
declare function resolveFriendlyStandardHandleOptions<T extends Context>(options: FriendlyStandardHandleOptions<T>): StandardHandleOptions<T>;
|
|
10
|
+
|
|
11
|
+
export { resolveFriendlyStandardHandleOptions as r };
|
|
12
|
+
export type { FriendlyStandardHandleOptions as F };
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { ORPCError, fallbackContractConfig } from '@orpc/contract';
|
|
2
|
+
|
|
3
|
+
const STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL = Symbol("STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT");
|
|
4
|
+
class StrictGetMethodPlugin {
|
|
5
|
+
error;
|
|
6
|
+
/**
|
|
7
|
+
* make sure execute before batch plugin to get real method
|
|
8
|
+
*/
|
|
9
|
+
order = 7e6;
|
|
10
|
+
constructor(options = {}) {
|
|
11
|
+
this.error = options.error ?? new ORPCError("METHOD_NOT_SUPPORTED");
|
|
12
|
+
}
|
|
13
|
+
init(options) {
|
|
14
|
+
options.rootInterceptors ??= [];
|
|
15
|
+
options.clientInterceptors ??= [];
|
|
16
|
+
options.rootInterceptors.unshift((options2) => {
|
|
17
|
+
const isGetMethod = options2.request.method === "GET";
|
|
18
|
+
return options2.next({
|
|
19
|
+
...options2,
|
|
20
|
+
context: {
|
|
21
|
+
...options2.context,
|
|
22
|
+
[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL]: isGetMethod
|
|
23
|
+
}
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
options.clientInterceptors.unshift((options2) => {
|
|
27
|
+
if (typeof options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] !== "boolean") {
|
|
28
|
+
throw new TypeError("[StrictGetMethodPlugin] strict GET method context has been corrupted or modified by another plugin or interceptor");
|
|
29
|
+
}
|
|
30
|
+
const procedureMethod = fallbackContractConfig("defaultMethod", options2.procedure["~orpc"].route.method);
|
|
31
|
+
if (options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] && procedureMethod !== "GET") {
|
|
32
|
+
throw this.error;
|
|
33
|
+
}
|
|
34
|
+
return options2.next();
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
export { StrictGetMethodPlugin as S };
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import '@orpc/client';
|
|
2
|
+
import '@orpc/shared';
|
|
3
|
+
import '@orpc/standard-server';
|
|
4
|
+
import '@orpc/contract';
|
|
5
|
+
import '@orpc/client/standard';
|
|
6
|
+
import { r as resolveFriendlyStandardHandleOptions } from './server.DZ5BIITo.mjs';
|
|
7
|
+
|
|
8
|
+
async function handleStandardServerPeerMessage(handler, peer, message, options) {
|
|
9
|
+
const [id, request] = await peer.message(message);
|
|
10
|
+
if (!request) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
const handle = createServerPeerHandleRequestFn(handler, options);
|
|
14
|
+
await peer.response(id, await handle(request));
|
|
15
|
+
}
|
|
16
|
+
function createServerPeerHandleRequestFn(handler, options) {
|
|
17
|
+
return async (request) => {
|
|
18
|
+
const { response } = await handler.handle(
|
|
19
|
+
{ ...request, body: () => Promise.resolve(request.body) },
|
|
20
|
+
resolveFriendlyStandardHandleOptions(options)
|
|
21
|
+
);
|
|
22
|
+
return response ?? { status: 404, headers: {}, body: "No procedure matched" };
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export { createServerPeerHandleRequestFn as c, handleStandardServerPeerMessage as h };
|
|
@@ -1,8 +1,8 @@
|
|
|
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>;
|
|
@@ -13,7 +13,6 @@ type ORPCErrorConstructorMap<T extends ErrorMap> = {
|
|
|
13
13
|
[K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
|
|
14
14
|
};
|
|
15
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
16
|
|
|
18
17
|
declare const LAZY_SYMBOL: unique symbol;
|
|
19
18
|
interface LazyMeta {
|
|
@@ -28,6 +27,11 @@ interface Lazy<T> {
|
|
|
28
27
|
};
|
|
29
28
|
}
|
|
30
29
|
type Lazyable<T> = T | Lazy<T>;
|
|
30
|
+
/**
|
|
31
|
+
* Creates a lazy-loaded item.
|
|
32
|
+
*
|
|
33
|
+
* @warning The `prefix` in `meta` only holds metadata and does not apply the prefix to the lazy router, use `os.prefix(...).lazy(...)` instead.
|
|
34
|
+
*/
|
|
31
35
|
declare function lazy<T>(loader: () => Promise<{
|
|
32
36
|
default: T;
|
|
33
37
|
}>, meta?: LazyMeta): Lazy<T>;
|
|
@@ -56,7 +60,15 @@ interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends
|
|
|
56
60
|
outputValidationIndex: number;
|
|
57
61
|
handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
|
|
58
62
|
}
|
|
63
|
+
/**
|
|
64
|
+
* This class represents a procedure.
|
|
65
|
+
*
|
|
66
|
+
* @see {@link https://orpc.dev/docs/procedure Procedure Docs}
|
|
67
|
+
*/
|
|
59
68
|
declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
69
|
+
/**
|
|
70
|
+
* This property holds the defined options.
|
|
71
|
+
*/
|
|
60
72
|
'~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
61
73
|
constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
62
74
|
}
|
|
@@ -87,6 +99,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
|
|
|
87
99
|
next: MiddlewareNextFn<TOutput>;
|
|
88
100
|
errors: TErrorConstructorMap;
|
|
89
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* A function that represents a middleware.
|
|
104
|
+
*
|
|
105
|
+
* @see {@link https://orpc.dev/docs/middleware Middleware Docs}
|
|
106
|
+
*/
|
|
90
107
|
interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
|
|
91
108
|
(options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
|
|
92
109
|
}
|
|
@@ -97,47 +114,80 @@ interface MapInputMiddleware<TInput, TMappedInput> {
|
|
|
97
114
|
declare function middlewareOutputFn<TOutput>(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
|
|
98
115
|
|
|
99
116
|
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,
|
|
117
|
+
interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
101
118
|
context: TInitialContext;
|
|
102
|
-
input:
|
|
119
|
+
input: unknown;
|
|
103
120
|
errors: ORPCErrorConstructorMap<TErrorMap>;
|
|
104
121
|
path: readonly string[];
|
|
105
122
|
procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
|
|
106
123
|
signal?: AbortSignal;
|
|
107
124
|
lastEventId: string | undefined;
|
|
108
125
|
}
|
|
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> = {
|
|
126
|
+
type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
|
|
113
127
|
/**
|
|
114
128
|
* This is helpful for logging and analytics.
|
|
115
129
|
*/
|
|
116
130
|
path?: readonly string[];
|
|
117
|
-
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext,
|
|
131
|
+
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
|
|
118
132
|
} & (Record<never, never> extends TInitialContext ? {
|
|
119
|
-
context?: Value<TInitialContext
|
|
133
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
120
134
|
} : {
|
|
121
|
-
context: Value<TInitialContext
|
|
135
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
122
136
|
});
|
|
123
|
-
|
|
137
|
+
/**
|
|
138
|
+
* Create Server-side client from a procedure.
|
|
139
|
+
*
|
|
140
|
+
* @see {@link https://orpc.dev/docs/client/server-side Server-side Client Docs}
|
|
141
|
+
*/
|
|
142
|
+
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
143
|
|
|
144
|
+
/**
|
|
145
|
+
* Represents a router, which defines a hierarchical structure of procedures.
|
|
146
|
+
*
|
|
147
|
+
* @info A procedure is a router too.
|
|
148
|
+
* @see {@link https://orpc.dev/docs/contract-first/define-contract#contract-router Contract Router Docs}
|
|
149
|
+
*/
|
|
125
150
|
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
151
|
[K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
|
|
127
152
|
};
|
|
128
153
|
type AnyRouter = Router<any, any>;
|
|
129
154
|
type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
|
|
155
|
+
/**
|
|
156
|
+
* Infer all initial context of the router.
|
|
157
|
+
*
|
|
158
|
+
* @info A procedure is a router too.
|
|
159
|
+
* @see {@link https://orpc.dev/docs/router#utilities Router Utilities Docs}
|
|
160
|
+
*/
|
|
130
161
|
type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
|
|
131
162
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
|
|
132
163
|
};
|
|
164
|
+
/**
|
|
165
|
+
* Infer all current context of the router.
|
|
166
|
+
*
|
|
167
|
+
* @info A procedure is a router too.
|
|
168
|
+
* @see {@link https://orpc.dev/docs/router#utilities Router Utilities Docs}
|
|
169
|
+
*/
|
|
133
170
|
type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
|
|
134
171
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
|
|
135
172
|
};
|
|
173
|
+
/**
|
|
174
|
+
* Infer all router inputs
|
|
175
|
+
*
|
|
176
|
+
* @info A procedure is a router too.
|
|
177
|
+
* @see {@link https://orpc.dev/docs/router#utilities Router Utilities Docs}
|
|
178
|
+
*/
|
|
136
179
|
type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
137
180
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
|
|
138
181
|
};
|
|
182
|
+
/**
|
|
183
|
+
* Infer all router outputs
|
|
184
|
+
*
|
|
185
|
+
* @info A procedure is a router too.
|
|
186
|
+
* @see {@link https://orpc.dev/docs/router#utilities Router Utilities Docs}
|
|
187
|
+
*/
|
|
139
188
|
type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
140
189
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
|
|
141
190
|
};
|
|
142
191
|
|
|
143
|
-
export {
|
|
192
|
+
export { isProcedure as E, createProcedureClient as F, 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, middlewareOutputFn as z };
|
|
193
|
+
export type { AnyProcedure as A, ProcedureHandlerOptions as B, Context as C, ProcedureDef as D, InferRouterInitialContexts as G, InferRouterCurrentContexts as H, InferRouterInitialContext as I, InferRouterInputs as J, InferRouterOutputs as K, Lazyable as L, MergedInitialContext as M, 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 v, MiddlewareNextFn as w, MiddlewareOutputFn as x, MiddlewareOptions as y };
|