@orpc/server 0.0.0-next.ee46dab → 0.0.0-next.ee89076
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 +20 -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 +81 -11
- package/dist/adapters/fetch/index.d.ts +81 -11
- package/dist/adapters/fetch/index.mjs +179 -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 +57 -11
- package/dist/adapters/node/index.d.ts +57 -11
- package/dist/adapters/node/index.mjs +89 -22
- 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 +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 +564 -52
- package/dist/index.d.ts +564 -52
- package/dist/index.mjs +140 -14
- package/dist/plugins/index.d.mts +148 -9
- package/dist/plugins/index.d.ts +148 -9
- package/dist/plugins/index.mjs +191 -11
- package/dist/shared/{server.DLt5njUb.d.mts → server.B4BGqy3Y.d.mts} +60 -10
- package/dist/shared/{server.DLt5njUb.d.ts → server.B4BGqy3Y.d.ts} +60 -10
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/server.COL12UTb.d.ts +32 -0
- package/dist/shared/server.CVKCo60T.d.mts +12 -0
- package/dist/shared/{server.e3W6AG3-.mjs → server.CaqDCZX1.mjs} +125 -86
- package/dist/shared/server.Cb6yD7DZ.d.ts +42 -0
- package/dist/shared/server.Ck-gOLzq.d.mts +32 -0
- package/dist/shared/{server.CzxlqYZL.d.mts → server.DBCUJijK.d.mts} +18 -10
- package/dist/shared/server.DNtJ-p60.d.ts +12 -0
- package/dist/shared/{server.BHlRCrf_.d.ts → server.DPIFWpxG.d.ts} +18 -10
- package/dist/shared/{server.BVwwTHyO.mjs → server.DZ5BIITo.mjs} +1 -1
- package/dist/shared/server.DzV1hr3z.d.mts +42 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/dist/shared/server.vzZSq5UM.mjs +219 -0
- package/package.json +71 -20
- package/dist/adapters/hono/index.d.mts +0 -22
- package/dist/adapters/hono/index.d.ts +0 -22
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -29
- package/dist/adapters/next/index.d.ts +0 -29
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.B77ImKAP.d.mts +0 -8
- package/dist/shared/server.Cud5qk0c.d.ts +0 -10
- package/dist/shared/server.DCCkTG29.mjs +0 -162
- package/dist/shared/server.DGnN7q3R.d.mts +0 -10
- package/dist/shared/server.DUF89eb-.d.ts +0 -8
- package/dist/shared/server.Prfzu_zf.mjs +0 -98
package/dist/plugins/index.mjs
CHANGED
@@ -1,7 +1,124 @@
|
|
1
|
-
import { value } from '@orpc/shared';
|
1
|
+
import { runWithSpan, value, setSpanError, isAsyncIteratorObject, AsyncIteratorClass, clone } from '@orpc/shared';
|
2
|
+
import { flattenHeader } from '@orpc/standard-server';
|
3
|
+
import { parseBatchRequest, toBatchResponse } from '@orpc/standard-server/batch';
|
4
|
+
import { toFetchHeaders } from '@orpc/standard-server-fetch';
|
5
|
+
import { ORPCError } from '@orpc/client';
|
6
|
+
export { S as StrictGetMethodPlugin } from '../shared/server.BW-nUGgA.mjs';
|
7
|
+
import '@orpc/contract';
|
8
|
+
|
9
|
+
class BatchHandlerPlugin {
|
10
|
+
maxSize;
|
11
|
+
mapRequestItem;
|
12
|
+
successStatus;
|
13
|
+
headers;
|
14
|
+
order = 5e6;
|
15
|
+
constructor(options = {}) {
|
16
|
+
this.maxSize = options.maxSize ?? 10;
|
17
|
+
this.mapRequestItem = options.mapRequestItem ?? ((request, { request: batchRequest }) => ({
|
18
|
+
...request,
|
19
|
+
headers: {
|
20
|
+
...batchRequest.headers,
|
21
|
+
...request.headers
|
22
|
+
}
|
23
|
+
}));
|
24
|
+
this.successStatus = options.successStatus ?? 207;
|
25
|
+
this.headers = options.headers ?? {};
|
26
|
+
}
|
27
|
+
init(options) {
|
28
|
+
options.rootInterceptors ??= [];
|
29
|
+
options.rootInterceptors.unshift(async (options2) => {
|
30
|
+
const xHeader = flattenHeader(options2.request.headers["x-orpc-batch"]);
|
31
|
+
if (xHeader === void 0) {
|
32
|
+
return options2.next();
|
33
|
+
}
|
34
|
+
let isParsing = false;
|
35
|
+
try {
|
36
|
+
return await runWithSpan({ name: "handle_batch_request" }, async (span) => {
|
37
|
+
const mode = xHeader === "buffered" ? "buffered" : "streaming";
|
38
|
+
isParsing = true;
|
39
|
+
const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
|
40
|
+
isParsing = false;
|
41
|
+
span?.setAttribute("batch.mode", mode);
|
42
|
+
span?.setAttribute("batch.size", parsed.length);
|
43
|
+
const maxSize = await value(this.maxSize, options2);
|
44
|
+
if (parsed.length > maxSize) {
|
45
|
+
const message = "Batch request size exceeds the maximum allowed size";
|
46
|
+
setSpanError(span, message);
|
47
|
+
return {
|
48
|
+
matched: true,
|
49
|
+
response: {
|
50
|
+
status: 413,
|
51
|
+
headers: {},
|
52
|
+
body: message
|
53
|
+
}
|
54
|
+
};
|
55
|
+
}
|
56
|
+
const responses = parsed.map(
|
57
|
+
(request, index) => {
|
58
|
+
const mapped = this.mapRequestItem(request, options2);
|
59
|
+
return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
|
60
|
+
span?.addEvent(`response.${index}.${matched ? "success" : "not_matched"}`);
|
61
|
+
if (matched) {
|
62
|
+
if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
|
63
|
+
return {
|
64
|
+
index,
|
65
|
+
status: 500,
|
66
|
+
headers: {},
|
67
|
+
body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
|
68
|
+
};
|
69
|
+
}
|
70
|
+
return { ...response2, index };
|
71
|
+
}
|
72
|
+
return { index, status: 404, headers: {}, body: "No procedure matched" };
|
73
|
+
}).catch((err) => {
|
74
|
+
Promise.reject(err);
|
75
|
+
return { index, status: 500, headers: {}, body: "Internal server error" };
|
76
|
+
});
|
77
|
+
}
|
78
|
+
);
|
79
|
+
await Promise.race(responses);
|
80
|
+
const status = await value(this.successStatus, responses, options2);
|
81
|
+
const headers = await value(this.headers, responses, options2);
|
82
|
+
const promises = [...responses];
|
83
|
+
const response = await toBatchResponse({
|
84
|
+
status,
|
85
|
+
headers,
|
86
|
+
mode,
|
87
|
+
body: new AsyncIteratorClass(
|
88
|
+
async () => {
|
89
|
+
const handling = promises.filter((p) => p !== void 0);
|
90
|
+
if (handling.length <= 0) {
|
91
|
+
return { done: true, value: void 0 };
|
92
|
+
}
|
93
|
+
const value2 = await Promise.race(handling);
|
94
|
+
promises[value2.index] = void 0;
|
95
|
+
return { done: false, value: value2 };
|
96
|
+
},
|
97
|
+
async () => {
|
98
|
+
}
|
99
|
+
)
|
100
|
+
});
|
101
|
+
return {
|
102
|
+
matched: true,
|
103
|
+
response
|
104
|
+
};
|
105
|
+
});
|
106
|
+
} catch (cause) {
|
107
|
+
if (isParsing) {
|
108
|
+
return {
|
109
|
+
matched: true,
|
110
|
+
response: { status: 400, headers: {}, body: "Invalid batch request, this could be caused by a malformed request body or a missing header" }
|
111
|
+
};
|
112
|
+
}
|
113
|
+
throw cause;
|
114
|
+
}
|
115
|
+
});
|
116
|
+
}
|
117
|
+
}
|
2
118
|
|
3
119
|
class CORSPlugin {
|
4
120
|
options;
|
121
|
+
order = 9e6;
|
5
122
|
constructor(options = {}) {
|
6
123
|
const defaults = {
|
7
124
|
origin: (origin) => origin,
|
@@ -21,13 +138,11 @@ class CORSPlugin {
|
|
21
138
|
resHeaders["access-control-max-age"] = this.options.maxAge.toString();
|
22
139
|
}
|
23
140
|
if (this.options.allowMethods?.length) {
|
24
|
-
resHeaders["access-control-allow-methods"] = this.options.allowMethods
|
141
|
+
resHeaders["access-control-allow-methods"] = flattenHeader(this.options.allowMethods);
|
25
142
|
}
|
26
143
|
const allowHeaders = this.options.allowHeaders ?? interceptorOptions.request.headers["access-control-request-headers"];
|
27
|
-
if (
|
28
|
-
resHeaders["access-control-allow-headers"] = allowHeaders
|
29
|
-
} else if (typeof allowHeaders === "string") {
|
30
|
-
resHeaders["access-control-allow-headers"] = allowHeaders;
|
144
|
+
if (typeof allowHeaders === "string" || allowHeaders?.length) {
|
145
|
+
resHeaders["access-control-allow-headers"] = flattenHeader(allowHeaders);
|
31
146
|
}
|
32
147
|
return {
|
33
148
|
matched: true,
|
@@ -45,7 +160,7 @@ class CORSPlugin {
|
|
45
160
|
if (!result.matched) {
|
46
161
|
return result;
|
47
162
|
}
|
48
|
-
const origin =
|
163
|
+
const origin = flattenHeader(interceptorOptions.request.headers.origin) ?? "";
|
49
164
|
const allowedOrigin = await value(this.options.origin, origin, interceptorOptions);
|
50
165
|
const allowedOriginArr = Array.isArray(allowedOrigin) ? allowedOrigin : [allowedOrigin];
|
51
166
|
if (allowedOriginArr.includes("*")) {
|
@@ -67,13 +182,29 @@ class CORSPlugin {
|
|
67
182
|
result.response.headers["access-control-allow-credentials"] = "true";
|
68
183
|
}
|
69
184
|
if (this.options.exposeHeaders?.length) {
|
70
|
-
result.response.headers["access-control-expose-headers"] = this.options.exposeHeaders
|
185
|
+
result.response.headers["access-control-expose-headers"] = flattenHeader(this.options.exposeHeaders);
|
71
186
|
}
|
72
187
|
return result;
|
73
188
|
});
|
74
189
|
}
|
75
190
|
}
|
76
191
|
|
192
|
+
class RequestHeadersPlugin {
|
193
|
+
init(options) {
|
194
|
+
options.rootInterceptors ??= [];
|
195
|
+
options.rootInterceptors.push((interceptorOptions) => {
|
196
|
+
const reqHeaders = interceptorOptions.context.reqHeaders ?? toFetchHeaders(interceptorOptions.request.headers);
|
197
|
+
return interceptorOptions.next({
|
198
|
+
...interceptorOptions,
|
199
|
+
context: {
|
200
|
+
...interceptorOptions.context,
|
201
|
+
reqHeaders
|
202
|
+
}
|
203
|
+
});
|
204
|
+
});
|
205
|
+
}
|
206
|
+
}
|
207
|
+
|
77
208
|
class ResponseHeadersPlugin {
|
78
209
|
init(options) {
|
79
210
|
options.rootInterceptors ??= [];
|
@@ -89,7 +220,7 @@ class ResponseHeadersPlugin {
|
|
89
220
|
if (!result.matched) {
|
90
221
|
return result;
|
91
222
|
}
|
92
|
-
const responseHeaders = result.response.headers;
|
223
|
+
const responseHeaders = clone(result.response.headers);
|
93
224
|
for (const [key, value] of resHeaders) {
|
94
225
|
if (Array.isArray(responseHeaders[key])) {
|
95
226
|
responseHeaders[key].push(value);
|
@@ -99,9 +230,58 @@ class ResponseHeadersPlugin {
|
|
99
230
|
responseHeaders[key] = value;
|
100
231
|
}
|
101
232
|
}
|
102
|
-
return
|
233
|
+
return {
|
234
|
+
...result,
|
235
|
+
response: {
|
236
|
+
...result.response,
|
237
|
+
headers: responseHeaders
|
238
|
+
}
|
239
|
+
};
|
240
|
+
});
|
241
|
+
}
|
242
|
+
}
|
243
|
+
|
244
|
+
const SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL = Symbol("SIMPLE_CSRF_PROTECTION_CONTEXT");
|
245
|
+
class SimpleCsrfProtectionHandlerPlugin {
|
246
|
+
headerName;
|
247
|
+
headerValue;
|
248
|
+
exclude;
|
249
|
+
error;
|
250
|
+
constructor(options = {}) {
|
251
|
+
this.headerName = options.headerName ?? "x-csrf-token";
|
252
|
+
this.headerValue = options.headerValue ?? "orpc";
|
253
|
+
this.exclude = options.exclude ?? false;
|
254
|
+
this.error = options.error ?? new ORPCError("CSRF_TOKEN_MISMATCH", {
|
255
|
+
status: 403,
|
256
|
+
message: "Invalid CSRF token"
|
257
|
+
});
|
258
|
+
}
|
259
|
+
order = 8e6;
|
260
|
+
init(options) {
|
261
|
+
options.rootInterceptors ??= [];
|
262
|
+
options.clientInterceptors ??= [];
|
263
|
+
options.rootInterceptors.unshift(async (options2) => {
|
264
|
+
const headerName = await value(this.headerName, options2);
|
265
|
+
const headerValue = await value(this.headerValue, options2);
|
266
|
+
return options2.next({
|
267
|
+
...options2,
|
268
|
+
context: {
|
269
|
+
...options2.context,
|
270
|
+
[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]: options2.request.headers[headerName] === headerValue
|
271
|
+
}
|
272
|
+
});
|
273
|
+
});
|
274
|
+
options.clientInterceptors.unshift(async (options2) => {
|
275
|
+
if (typeof options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL] !== "boolean") {
|
276
|
+
throw new TypeError("[SimpleCsrfProtectionHandlerPlugin] CSRF protection context has been corrupted or modified by another plugin or interceptor");
|
277
|
+
}
|
278
|
+
const excluded = await value(this.exclude, options2);
|
279
|
+
if (!excluded && !options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]) {
|
280
|
+
throw this.error;
|
281
|
+
}
|
282
|
+
return options2.next();
|
103
283
|
});
|
104
284
|
}
|
105
285
|
}
|
106
286
|
|
107
|
-
export { CORSPlugin, ResponseHeadersPlugin };
|
287
|
+
export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
|
2
|
-
import { MaybeOptionalOptions, Promisable, Interceptor, Value } from '@orpc/shared';
|
3
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
5
|
type Context = Record<PropertyKey, any>;
|
6
6
|
type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
|
@@ -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.unnoq.com/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.unnoq.com/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
|
}
|
@@ -106,38 +123,71 @@ interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TEr
|
|
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
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, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap
|
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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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 };
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
|
2
|
-
import { MaybeOptionalOptions, Promisable, Interceptor, Value } from '@orpc/shared';
|
3
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
5
|
type Context = Record<PropertyKey, any>;
|
6
6
|
type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
|
@@ -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.unnoq.com/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.unnoq.com/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
|
}
|
@@ -106,38 +123,71 @@ interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TEr
|
|
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
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, TErrorMap, TMeta>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap
|
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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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.unnoq.com/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 };
|
@@ -0,0 +1,36 @@
|
|
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
|
+
order = 7e6;
|
7
|
+
constructor(options = {}) {
|
8
|
+
this.error = options.error ?? new ORPCError("METHOD_NOT_SUPPORTED");
|
9
|
+
}
|
10
|
+
init(options) {
|
11
|
+
options.rootInterceptors ??= [];
|
12
|
+
options.clientInterceptors ??= [];
|
13
|
+
options.rootInterceptors.unshift((options2) => {
|
14
|
+
const isGetMethod = options2.request.method === "GET";
|
15
|
+
return options2.next({
|
16
|
+
...options2,
|
17
|
+
context: {
|
18
|
+
...options2.context,
|
19
|
+
[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL]: isGetMethod
|
20
|
+
}
|
21
|
+
});
|
22
|
+
});
|
23
|
+
options.clientInterceptors.unshift((options2) => {
|
24
|
+
if (typeof options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] !== "boolean") {
|
25
|
+
throw new TypeError("[StrictGetMethodPlugin] strict GET method context has been corrupted or modified by another plugin or interceptor");
|
26
|
+
}
|
27
|
+
const procedureMethod = fallbackContractConfig("defaultMethod", options2.procedure["~orpc"].route.method);
|
28
|
+
if (options2.context[STRICT_GET_METHOD_PLUGIN_IS_GET_METHOD_CONTEXT_SYMBOL] && procedureMethod !== "GET") {
|
29
|
+
throw this.error;
|
30
|
+
}
|
31
|
+
return options2.next();
|
32
|
+
});
|
33
|
+
}
|
34
|
+
}
|
35
|
+
|
36
|
+
export { StrictGetMethodPlugin as S };
|
@@ -0,0 +1,32 @@
|
|
1
|
+
import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
|
2
|
+
import { b as AnyRouter, C as Context, R as Router } from './server.B4BGqy3Y.js';
|
3
|
+
import { i as StandardMatcher, h as StandardMatchResult, e as StandardHandlerOptions, f as StandardHandler } from './server.DPIFWpxG.js';
|
4
|
+
import { HTTPPath } from '@orpc/client';
|
5
|
+
import { Value } from '@orpc/shared';
|
6
|
+
import { T as TraverseContractProcedureCallbackOptions } from './server.Cb6yD7DZ.js';
|
7
|
+
|
8
|
+
interface StandardRPCMatcherOptions {
|
9
|
+
/**
|
10
|
+
* Filter procedures. Return `false` to exclude a procedure from matching.
|
11
|
+
*
|
12
|
+
* @default true
|
13
|
+
*/
|
14
|
+
filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
|
15
|
+
}
|
16
|
+
declare class StandardRPCMatcher implements StandardMatcher {
|
17
|
+
private readonly filter;
|
18
|
+
private readonly tree;
|
19
|
+
private pendingRouters;
|
20
|
+
constructor(options?: StandardRPCMatcherOptions);
|
21
|
+
init(router: AnyRouter, path?: readonly string[]): void;
|
22
|
+
match(_method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
23
|
+
}
|
24
|
+
|
25
|
+
interface StandardRPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardRPCJsonSerializerOptions, StandardRPCMatcherOptions {
|
26
|
+
}
|
27
|
+
declare class StandardRPCHandler<T extends Context> extends StandardHandler<T> {
|
28
|
+
constructor(router: Router<any, T>, options?: StandardRPCHandlerOptions<T>);
|
29
|
+
}
|
30
|
+
|
31
|
+
export { StandardRPCHandler as a, StandardRPCMatcher as c };
|
32
|
+
export type { StandardRPCHandlerOptions as S, StandardRPCMatcherOptions as b };
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import { C as Context } from './server.B4BGqy3Y.mjs';
|
2
|
+
import { b as StandardHandleOptions } from './server.DBCUJijK.mjs';
|
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 };
|