@orpc/server 0.0.0-next.c40d0c9 → 0.0.0-next.c4671e3
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 +13 -17
- package/dist/adapters/bun-ws/index.d.mts +35 -0
- package/dist/adapters/bun-ws/index.d.ts +35 -0
- package/dist/adapters/bun-ws/index.mjs +50 -0
- package/dist/adapters/crossws/index.d.mts +30 -0
- package/dist/adapters/crossws/index.d.ts +30 -0
- package/dist/adapters/crossws/index.mjs +50 -0
- package/dist/adapters/fetch/index.d.mts +33 -9
- package/dist/adapters/fetch/index.d.ts +33 -9
- package/dist/adapters/fetch/index.mjs +109 -8
- package/dist/adapters/node/index.d.mts +33 -9
- package/dist/adapters/node/index.d.ts +33 -9
- package/dist/adapters/node/index.mjs +22 -12
- package/dist/adapters/standard/index.d.mts +4 -4
- package/dist/adapters/standard/index.d.ts +4 -4
- package/dist/adapters/standard/index.mjs +3 -3
- package/dist/adapters/websocket/index.d.mts +27 -0
- package/dist/adapters/websocket/index.d.ts +27 -0
- package/dist/adapters/websocket/index.mjs +37 -0
- package/dist/adapters/ws/index.d.mts +28 -0
- package/dist/adapters/ws/index.d.ts +28 -0
- package/dist/adapters/ws/index.mjs +37 -0
- package/dist/index.d.mts +548 -10
- package/dist/index.d.ts +548 -10
- package/dist/index.mjs +122 -11
- package/dist/plugins/index.d.mts +132 -6
- package/dist/plugins/index.d.ts +132 -6
- package/dist/plugins/index.mjs +153 -9
- package/dist/shared/server.BRoxSiSC.d.mts +12 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/{server.Cud5qk0c.d.ts → server.BjiJH9Vo.d.ts} +2 -2
- package/dist/shared/server.Cy1vfSiG.d.ts +12 -0
- package/dist/shared/{server.e3W6AG3-.mjs → server.DG7Tamti.mjs} +19 -22
- package/dist/shared/{server.DLt5njUb.d.mts → server.DPWk5pjW.d.mts} +54 -5
- package/dist/shared/{server.DLt5njUb.d.ts → server.DPWk5pjW.d.ts} +54 -5
- package/dist/shared/{server.DGnN7q3R.d.mts → server.QUe9N8P4.d.mts} +2 -2
- package/dist/shared/{server.DCCkTG29.mjs → server.SxlTJfG2.mjs} +27 -6
- package/dist/shared/{server.BHlRCrf_.d.ts → server.YZzrREz9.d.ts} +13 -5
- package/dist/shared/{server.CzxlqYZL.d.mts → server.eWLxY3lq.d.mts} +13 -5
- package/package.json +43 -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.DUF89eb-.d.ts +0 -8
- package/dist/shared/server.Prfzu_zf.mjs +0 -98
package/dist/index.mjs
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter } from '@orpc/contract';
|
2
2
|
export { ValidationError, eventIterator, type } from '@orpc/contract';
|
3
|
-
import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure, g as getRouter } from './shared/server.
|
4
|
-
export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter, a as createContractedProcedure, h as createORPCErrorConstructorMap, q as getHiddenRouterContract, j as getLazyMeta, n as isStartWithMiddlewares, m as mergeCurrentContext, o as mergeMiddlewares, k as middlewareOutputFn, w as resolveContractProcedures, t as traverseContractProcedures, u as unlazy, x as unlazyRouter, v as validateORPCError } from './shared/server.
|
3
|
+
import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure, g as getRouter } from './shared/server.DG7Tamti.mjs';
|
4
|
+
export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter, a as createContractedProcedure, h as createORPCErrorConstructorMap, q as getHiddenRouterContract, j as getLazyMeta, n as isStartWithMiddlewares, m as mergeCurrentContext, o as mergeMiddlewares, k as middlewareOutputFn, w as resolveContractProcedures, t as traverseContractProcedures, u as unlazy, x as unlazyRouter, v as validateORPCError } from './shared/server.DG7Tamti.mjs';
|
5
5
|
import { toORPCError } from '@orpc/client';
|
6
6
|
export { ORPCError, isDefinedError, safe } from '@orpc/client';
|
7
7
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
@@ -50,6 +50,9 @@ function createActionableClient(client) {
|
|
50
50
|
try {
|
51
51
|
return [null, await client(input)];
|
52
52
|
} catch (error) {
|
53
|
+
if (error instanceof Error && "digest" in error && typeof error.digest === "string" && error.digest.startsWith("NEXT_")) {
|
54
|
+
throw error;
|
55
|
+
}
|
53
56
|
return [toORPCError(error).toJSON(), void 0];
|
54
57
|
}
|
55
58
|
};
|
@@ -57,18 +60,38 @@ function createActionableClient(client) {
|
|
57
60
|
}
|
58
61
|
|
59
62
|
class DecoratedProcedure extends Procedure {
|
63
|
+
/**
|
64
|
+
* Adds type-safe custom errors.
|
65
|
+
* The provided errors are spared-merged with any existing errors.
|
66
|
+
*
|
67
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
68
|
+
*/
|
60
69
|
errors(errors) {
|
61
70
|
return new DecoratedProcedure({
|
62
71
|
...this["~orpc"],
|
63
72
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
64
73
|
});
|
65
74
|
}
|
75
|
+
/**
|
76
|
+
* Sets or updates the metadata.
|
77
|
+
* The provided metadata is spared-merged with any existing metadata.
|
78
|
+
*
|
79
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
80
|
+
*/
|
66
81
|
meta(meta) {
|
67
82
|
return new DecoratedProcedure({
|
68
83
|
...this["~orpc"],
|
69
84
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
70
85
|
});
|
71
86
|
}
|
87
|
+
/**
|
88
|
+
* Sets or updates the route definition.
|
89
|
+
* The provided route is spared-merged with any existing route.
|
90
|
+
* This option is typically relevant when integrating with OpenAPI.
|
91
|
+
*
|
92
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
93
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
94
|
+
*/
|
72
95
|
route(route) {
|
73
96
|
return new DecoratedProcedure({
|
74
97
|
...this["~orpc"],
|
@@ -84,6 +107,8 @@ class DecoratedProcedure extends Procedure {
|
|
84
107
|
}
|
85
108
|
/**
|
86
109
|
* Make this procedure callable (works like a function while still being a procedure).
|
110
|
+
*
|
111
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
87
112
|
*/
|
88
113
|
callable(...rest) {
|
89
114
|
const client = createProcedureClient(this, ...rest);
|
@@ -98,6 +123,8 @@ class DecoratedProcedure extends Procedure {
|
|
98
123
|
}
|
99
124
|
/**
|
100
125
|
* Make this procedure compatible with server action.
|
126
|
+
*
|
127
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
101
128
|
*/
|
102
129
|
actionable(...rest) {
|
103
130
|
const action = createActionableClient(createProcedureClient(this, ...rest));
|
@@ -113,12 +140,18 @@ class DecoratedProcedure extends Procedure {
|
|
113
140
|
}
|
114
141
|
|
115
142
|
class Builder {
|
143
|
+
/**
|
144
|
+
* This property holds the defined options.
|
145
|
+
*/
|
116
146
|
"~orpc";
|
117
147
|
constructor(def) {
|
118
148
|
this["~orpc"] = def;
|
119
149
|
}
|
120
150
|
/**
|
121
|
-
*
|
151
|
+
* Sets or overrides the config.
|
152
|
+
*
|
153
|
+
* @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
|
154
|
+
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
122
155
|
*/
|
123
156
|
$config(config) {
|
124
157
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
@@ -132,7 +165,9 @@ class Builder {
|
|
132
165
|
});
|
133
166
|
}
|
134
167
|
/**
|
135
|
-
*
|
168
|
+
* Set or override the initial context.
|
169
|
+
*
|
170
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
136
171
|
*/
|
137
172
|
$context() {
|
138
173
|
return new Builder({
|
@@ -143,7 +178,9 @@ class Builder {
|
|
143
178
|
});
|
144
179
|
}
|
145
180
|
/**
|
146
|
-
*
|
181
|
+
* Sets or overrides the initial meta.
|
182
|
+
*
|
183
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
147
184
|
*/
|
148
185
|
$meta(initialMeta) {
|
149
186
|
return new Builder({
|
@@ -152,7 +189,11 @@ class Builder {
|
|
152
189
|
});
|
153
190
|
}
|
154
191
|
/**
|
155
|
-
*
|
192
|
+
* Sets or overrides the initial route.
|
193
|
+
* This option is typically relevant when integrating with OpenAPI.
|
194
|
+
*
|
195
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
196
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
156
197
|
*/
|
157
198
|
$route(initialRoute) {
|
158
199
|
return new Builder({
|
@@ -160,15 +201,31 @@ class Builder {
|
|
160
201
|
route: initialRoute
|
161
202
|
});
|
162
203
|
}
|
204
|
+
/**
|
205
|
+
* Sets or overrides the initial input schema.
|
206
|
+
*
|
207
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
|
208
|
+
*/
|
163
209
|
$input(initialInputSchema) {
|
164
210
|
return new Builder({
|
165
211
|
...this["~orpc"],
|
166
212
|
inputSchema: initialInputSchema
|
167
213
|
});
|
168
214
|
}
|
215
|
+
/**
|
216
|
+
* Creates a middleware.
|
217
|
+
*
|
218
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
219
|
+
*/
|
169
220
|
middleware(middleware) {
|
170
221
|
return decorateMiddleware(middleware);
|
171
222
|
}
|
223
|
+
/**
|
224
|
+
* Adds type-safe custom errors.
|
225
|
+
* The provided errors are spared-merged with any existing errors.
|
226
|
+
*
|
227
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
228
|
+
*/
|
172
229
|
errors(errors) {
|
173
230
|
return new Builder({
|
174
231
|
...this["~orpc"],
|
@@ -182,18 +239,37 @@ class Builder {
|
|
182
239
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
183
240
|
});
|
184
241
|
}
|
242
|
+
/**
|
243
|
+
* Sets or updates the metadata.
|
244
|
+
* The provided metadata is spared-merged with any existing metadata.
|
245
|
+
*
|
246
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
247
|
+
*/
|
185
248
|
meta(meta) {
|
186
249
|
return new Builder({
|
187
250
|
...this["~orpc"],
|
188
251
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
189
252
|
});
|
190
253
|
}
|
254
|
+
/**
|
255
|
+
* Sets or updates the route definition.
|
256
|
+
* The provided route is spared-merged with any existing route.
|
257
|
+
* This option is typically relevant when integrating with OpenAPI.
|
258
|
+
*
|
259
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
260
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
261
|
+
*/
|
191
262
|
route(route) {
|
192
263
|
return new Builder({
|
193
264
|
...this["~orpc"],
|
194
265
|
route: mergeRoute(this["~orpc"].route, route)
|
195
266
|
});
|
196
267
|
}
|
268
|
+
/**
|
269
|
+
* Defines the input validation schema.
|
270
|
+
*
|
271
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
272
|
+
*/
|
197
273
|
input(schema) {
|
198
274
|
return new Builder({
|
199
275
|
...this["~orpc"],
|
@@ -201,6 +277,11 @@ class Builder {
|
|
201
277
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
202
278
|
});
|
203
279
|
}
|
280
|
+
/**
|
281
|
+
* Defines the output validation schema.
|
282
|
+
*
|
283
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
284
|
+
*/
|
204
285
|
output(schema) {
|
205
286
|
return new Builder({
|
206
287
|
...this["~orpc"],
|
@@ -208,27 +289,57 @@ class Builder {
|
|
208
289
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
209
290
|
});
|
210
291
|
}
|
292
|
+
/**
|
293
|
+
* Defines the handler of the procedure.
|
294
|
+
*
|
295
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
296
|
+
*/
|
211
297
|
handler(handler) {
|
212
298
|
return new DecoratedProcedure({
|
213
299
|
...this["~orpc"],
|
214
300
|
handler
|
215
301
|
});
|
216
302
|
}
|
303
|
+
/**
|
304
|
+
* Prefixes all procedures in the router.
|
305
|
+
* The provided prefix is post-appended to any existing router prefix.
|
306
|
+
*
|
307
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
308
|
+
*
|
309
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
310
|
+
*/
|
217
311
|
prefix(prefix) {
|
218
312
|
return new Builder({
|
219
313
|
...this["~orpc"],
|
220
314
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
221
315
|
});
|
222
316
|
}
|
317
|
+
/**
|
318
|
+
* Adds tags to all procedures in the router.
|
319
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
320
|
+
*
|
321
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
322
|
+
*/
|
223
323
|
tag(...tags) {
|
224
324
|
return new Builder({
|
225
325
|
...this["~orpc"],
|
226
326
|
tags: mergeTags(this["~orpc"].tags, tags)
|
227
327
|
});
|
228
328
|
}
|
329
|
+
/**
|
330
|
+
* Applies all of the previously defined options to the specified router.
|
331
|
+
*
|
332
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
333
|
+
*/
|
229
334
|
router(router) {
|
230
335
|
return enhanceRouter(router, this["~orpc"]);
|
231
336
|
}
|
337
|
+
/**
|
338
|
+
* Create a lazy router
|
339
|
+
* And applies all of the previously defined options to the specified router.
|
340
|
+
*
|
341
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
342
|
+
*/
|
232
343
|
lazy(loader) {
|
233
344
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
234
345
|
}
|
@@ -336,12 +447,12 @@ function implement(contract, config = {}) {
|
|
336
447
|
return impl;
|
337
448
|
}
|
338
449
|
|
339
|
-
function createRouterClient(router, ...
|
450
|
+
function createRouterClient(router, ...rest) {
|
340
451
|
if (isProcedure(router)) {
|
341
|
-
const caller = createProcedureClient(router,
|
452
|
+
const caller = createProcedureClient(router, ...rest);
|
342
453
|
return caller;
|
343
454
|
}
|
344
|
-
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router),
|
455
|
+
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), ...rest) : {};
|
345
456
|
const recursive = new Proxy(procedureCaller, {
|
346
457
|
get(target, key) {
|
347
458
|
if (typeof key !== "string") {
|
@@ -352,8 +463,8 @@ function createRouterClient(router, ...[options]) {
|
|
352
463
|
return Reflect.get(target, key);
|
353
464
|
}
|
354
465
|
return createRouterClient(next, {
|
355
|
-
...
|
356
|
-
path: [...
|
466
|
+
...rest[0],
|
467
|
+
path: [...rest[0]?.path ?? [], key]
|
357
468
|
});
|
358
469
|
}
|
359
470
|
});
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,9 +1,52 @@
|
|
1
|
-
import { b as StandardHandlerInterceptorOptions, c as StandardHandlerPlugin, a as StandardHandlerOptions } from '../shared/server.CzxlqYZL.mjs';
|
2
1
|
import { Value } from '@orpc/shared';
|
3
|
-
import {
|
4
|
-
import '@orpc/
|
5
|
-
import '
|
6
|
-
import '
|
2
|
+
import { StandardRequest, StandardHeaders } from '@orpc/standard-server';
|
3
|
+
import { BatchResponseBodyItem } from '@orpc/standard-server/batch';
|
4
|
+
import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.eWLxY3lq.mjs';
|
5
|
+
import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DPWk5pjW.mjs';
|
6
|
+
import { Meta, ORPCError as ORPCError$1 } from '@orpc/contract';
|
7
|
+
import { ORPCError } from '@orpc/client';
|
8
|
+
|
9
|
+
interface BatchHandlerOptions<T extends Context> {
|
10
|
+
/**
|
11
|
+
* The max size of the batch allowed.
|
12
|
+
*
|
13
|
+
* @default 10
|
14
|
+
*/
|
15
|
+
maxSize?: Value<number, [StandardHandlerInterceptorOptions<T>]>;
|
16
|
+
/**
|
17
|
+
* Map the request before processing it.
|
18
|
+
*
|
19
|
+
* @default merged back batch request headers into the request
|
20
|
+
*/
|
21
|
+
mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
|
22
|
+
/**
|
23
|
+
* Success batch response status code.
|
24
|
+
*
|
25
|
+
* @default 207
|
26
|
+
*/
|
27
|
+
successStatus?: Value<number, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
28
|
+
/**
|
29
|
+
* success batch response headers.
|
30
|
+
*
|
31
|
+
* @default {}
|
32
|
+
*/
|
33
|
+
headers?: Value<StandardHeaders, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
34
|
+
}
|
35
|
+
/**
|
36
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
37
|
+
* reducing the overhead of sending each one separately.
|
38
|
+
*
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
40
|
+
*/
|
41
|
+
declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
42
|
+
private readonly maxSize;
|
43
|
+
private readonly mapRequestItem;
|
44
|
+
private readonly successStatus;
|
45
|
+
private readonly headers;
|
46
|
+
order: number;
|
47
|
+
constructor(options?: BatchHandlerOptions<T>);
|
48
|
+
init(options: StandardHandlerOptions<T>): void;
|
49
|
+
}
|
7
50
|
|
8
51
|
interface CORSOptions<T extends Context> {
|
9
52
|
origin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
@@ -14,8 +57,14 @@ interface CORSOptions<T extends Context> {
|
|
14
57
|
credentials?: boolean;
|
15
58
|
exposeHeaders?: readonly string[];
|
16
59
|
}
|
60
|
+
/**
|
61
|
+
* CORSPlugin is a plugin for oRPC that allows you to configure CORS for your API.
|
62
|
+
*
|
63
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/cors CORS Plugin Docs}
|
64
|
+
*/
|
17
65
|
declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
18
66
|
private readonly options;
|
67
|
+
order: number;
|
19
68
|
constructor(options?: CORSOptions<T>);
|
20
69
|
init(options: StandardHandlerOptions<T>): void;
|
21
70
|
}
|
@@ -23,8 +72,85 @@ declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T>
|
|
23
72
|
interface ResponseHeadersPluginContext {
|
24
73
|
resHeaders?: Headers;
|
25
74
|
}
|
75
|
+
/**
|
76
|
+
* The Response Headers Plugin allows you to set response headers in oRPC.
|
77
|
+
* It injects a resHeaders instance into the context, enabling you to modify response headers easily.
|
78
|
+
*
|
79
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
|
80
|
+
*/
|
26
81
|
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
27
82
|
init(options: StandardHandlerOptions<T>): void;
|
28
83
|
}
|
29
84
|
|
30
|
-
|
85
|
+
interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
|
86
|
+
/**
|
87
|
+
* The name of the header to check.
|
88
|
+
*
|
89
|
+
* @default 'x-csrf-token'
|
90
|
+
*/
|
91
|
+
headerName?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
|
92
|
+
/**
|
93
|
+
* The value of the header to check.
|
94
|
+
*
|
95
|
+
* @default 'orpc'
|
96
|
+
*
|
97
|
+
*/
|
98
|
+
headerValue?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
|
99
|
+
/**
|
100
|
+
* Exclude a procedure from the plugin.
|
101
|
+
*
|
102
|
+
* @default false
|
103
|
+
*
|
104
|
+
*/
|
105
|
+
exclude?: Value<boolean, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
|
106
|
+
/**
|
107
|
+
* The error thrown when the CSRF token is invalid.
|
108
|
+
*
|
109
|
+
* @default new ORPCError('CSRF_TOKEN_MISMATCH', {
|
110
|
+
* status: 403,
|
111
|
+
* message: 'Invalid CSRF token',
|
112
|
+
* })
|
113
|
+
*/
|
114
|
+
error?: InstanceType<typeof ORPCError>;
|
115
|
+
}
|
116
|
+
/**
|
117
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
118
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
119
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
120
|
+
*
|
121
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
122
|
+
*/
|
123
|
+
declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
124
|
+
private readonly headerName;
|
125
|
+
private readonly headerValue;
|
126
|
+
private readonly exclude;
|
127
|
+
private readonly error;
|
128
|
+
constructor(options?: SimpleCsrfProtectionHandlerPluginOptions<T>);
|
129
|
+
order: number;
|
130
|
+
init(options: StandardHandlerOptions<T>): void;
|
131
|
+
}
|
132
|
+
|
133
|
+
interface StrictGetMethodPluginOptions {
|
134
|
+
/**
|
135
|
+
* The error thrown when a GET request is made to a procedure that doesn't allow GET.
|
136
|
+
*
|
137
|
+
* @default new ORPCError('METHOD_NOT_SUPPORTED')
|
138
|
+
*/
|
139
|
+
error?: InstanceType<typeof ORPCError$1>;
|
140
|
+
}
|
141
|
+
/**
|
142
|
+
* This plugin enhances security by ensuring only procedures explicitly marked to accept GET requests
|
143
|
+
* can be called using the HTTP GET method for RPC Protocol. This helps prevent certain types of
|
144
|
+
* Cross-Site Request Forgery (CSRF) attacks.
|
145
|
+
*
|
146
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/strict-get-method Strict Get Method Plugin Docs}
|
147
|
+
*/
|
148
|
+
declare class StrictGetMethodPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
149
|
+
private readonly error;
|
150
|
+
order: number;
|
151
|
+
constructor(options?: StrictGetMethodPluginOptions);
|
152
|
+
init(options: StandardHandlerOptions<T>): void;
|
153
|
+
}
|
154
|
+
|
155
|
+
export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
156
|
+
export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,9 +1,52 @@
|
|
1
|
-
import { b as StandardHandlerInterceptorOptions, c as StandardHandlerPlugin, a as StandardHandlerOptions } from '../shared/server.BHlRCrf_.js';
|
2
1
|
import { Value } from '@orpc/shared';
|
3
|
-
import {
|
4
|
-
import '@orpc/
|
5
|
-
import '
|
6
|
-
import '
|
2
|
+
import { StandardRequest, StandardHeaders } from '@orpc/standard-server';
|
3
|
+
import { BatchResponseBodyItem } from '@orpc/standard-server/batch';
|
4
|
+
import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.YZzrREz9.js';
|
5
|
+
import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DPWk5pjW.js';
|
6
|
+
import { Meta, ORPCError as ORPCError$1 } from '@orpc/contract';
|
7
|
+
import { ORPCError } from '@orpc/client';
|
8
|
+
|
9
|
+
interface BatchHandlerOptions<T extends Context> {
|
10
|
+
/**
|
11
|
+
* The max size of the batch allowed.
|
12
|
+
*
|
13
|
+
* @default 10
|
14
|
+
*/
|
15
|
+
maxSize?: Value<number, [StandardHandlerInterceptorOptions<T>]>;
|
16
|
+
/**
|
17
|
+
* Map the request before processing it.
|
18
|
+
*
|
19
|
+
* @default merged back batch request headers into the request
|
20
|
+
*/
|
21
|
+
mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
|
22
|
+
/**
|
23
|
+
* Success batch response status code.
|
24
|
+
*
|
25
|
+
* @default 207
|
26
|
+
*/
|
27
|
+
successStatus?: Value<number, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
28
|
+
/**
|
29
|
+
* success batch response headers.
|
30
|
+
*
|
31
|
+
* @default {}
|
32
|
+
*/
|
33
|
+
headers?: Value<StandardHeaders, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
34
|
+
}
|
35
|
+
/**
|
36
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
37
|
+
* reducing the overhead of sending each one separately.
|
38
|
+
*
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
40
|
+
*/
|
41
|
+
declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
42
|
+
private readonly maxSize;
|
43
|
+
private readonly mapRequestItem;
|
44
|
+
private readonly successStatus;
|
45
|
+
private readonly headers;
|
46
|
+
order: number;
|
47
|
+
constructor(options?: BatchHandlerOptions<T>);
|
48
|
+
init(options: StandardHandlerOptions<T>): void;
|
49
|
+
}
|
7
50
|
|
8
51
|
interface CORSOptions<T extends Context> {
|
9
52
|
origin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
@@ -14,8 +57,14 @@ interface CORSOptions<T extends Context> {
|
|
14
57
|
credentials?: boolean;
|
15
58
|
exposeHeaders?: readonly string[];
|
16
59
|
}
|
60
|
+
/**
|
61
|
+
* CORSPlugin is a plugin for oRPC that allows you to configure CORS for your API.
|
62
|
+
*
|
63
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/cors CORS Plugin Docs}
|
64
|
+
*/
|
17
65
|
declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
18
66
|
private readonly options;
|
67
|
+
order: number;
|
19
68
|
constructor(options?: CORSOptions<T>);
|
20
69
|
init(options: StandardHandlerOptions<T>): void;
|
21
70
|
}
|
@@ -23,8 +72,85 @@ declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T>
|
|
23
72
|
interface ResponseHeadersPluginContext {
|
24
73
|
resHeaders?: Headers;
|
25
74
|
}
|
75
|
+
/**
|
76
|
+
* The Response Headers Plugin allows you to set response headers in oRPC.
|
77
|
+
* It injects a resHeaders instance into the context, enabling you to modify response headers easily.
|
78
|
+
*
|
79
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
|
80
|
+
*/
|
26
81
|
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
27
82
|
init(options: StandardHandlerOptions<T>): void;
|
28
83
|
}
|
29
84
|
|
30
|
-
|
85
|
+
interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
|
86
|
+
/**
|
87
|
+
* The name of the header to check.
|
88
|
+
*
|
89
|
+
* @default 'x-csrf-token'
|
90
|
+
*/
|
91
|
+
headerName?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
|
92
|
+
/**
|
93
|
+
* The value of the header to check.
|
94
|
+
*
|
95
|
+
* @default 'orpc'
|
96
|
+
*
|
97
|
+
*/
|
98
|
+
headerValue?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
|
99
|
+
/**
|
100
|
+
* Exclude a procedure from the plugin.
|
101
|
+
*
|
102
|
+
* @default false
|
103
|
+
*
|
104
|
+
*/
|
105
|
+
exclude?: Value<boolean, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
|
106
|
+
/**
|
107
|
+
* The error thrown when the CSRF token is invalid.
|
108
|
+
*
|
109
|
+
* @default new ORPCError('CSRF_TOKEN_MISMATCH', {
|
110
|
+
* status: 403,
|
111
|
+
* message: 'Invalid CSRF token',
|
112
|
+
* })
|
113
|
+
*/
|
114
|
+
error?: InstanceType<typeof ORPCError>;
|
115
|
+
}
|
116
|
+
/**
|
117
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
118
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
119
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
120
|
+
*
|
121
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
122
|
+
*/
|
123
|
+
declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
124
|
+
private readonly headerName;
|
125
|
+
private readonly headerValue;
|
126
|
+
private readonly exclude;
|
127
|
+
private readonly error;
|
128
|
+
constructor(options?: SimpleCsrfProtectionHandlerPluginOptions<T>);
|
129
|
+
order: number;
|
130
|
+
init(options: StandardHandlerOptions<T>): void;
|
131
|
+
}
|
132
|
+
|
133
|
+
interface StrictGetMethodPluginOptions {
|
134
|
+
/**
|
135
|
+
* The error thrown when a GET request is made to a procedure that doesn't allow GET.
|
136
|
+
*
|
137
|
+
* @default new ORPCError('METHOD_NOT_SUPPORTED')
|
138
|
+
*/
|
139
|
+
error?: InstanceType<typeof ORPCError$1>;
|
140
|
+
}
|
141
|
+
/**
|
142
|
+
* This plugin enhances security by ensuring only procedures explicitly marked to accept GET requests
|
143
|
+
* can be called using the HTTP GET method for RPC Protocol. This helps prevent certain types of
|
144
|
+
* Cross-Site Request Forgery (CSRF) attacks.
|
145
|
+
*
|
146
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/strict-get-method Strict Get Method Plugin Docs}
|
147
|
+
*/
|
148
|
+
declare class StrictGetMethodPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
149
|
+
private readonly error;
|
150
|
+
order: number;
|
151
|
+
constructor(options?: StrictGetMethodPluginOptions);
|
152
|
+
init(options: StandardHandlerOptions<T>): void;
|
153
|
+
}
|
154
|
+
|
155
|
+
export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
156
|
+
export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|