@orpc/server 0.0.0-next.ee46dab → 0.0.0-next.eea495c
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/fetch/index.d.mts +24 -8
- package/dist/adapters/fetch/index.d.ts +24 -8
- package/dist/adapters/fetch/index.mjs +104 -8
- package/dist/adapters/node/index.d.mts +24 -8
- package/dist/adapters/node/index.d.ts +24 -8
- package/dist/adapters/node/index.mjs +17 -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 +6 -4
- package/dist/index.d.mts +548 -10
- package/dist/index.d.ts +548 -10
- package/dist/index.mjs +119 -11
- package/dist/plugins/index.d.mts +132 -6
- package/dist/plugins/index.d.ts +132 -6
- package/dist/plugins/index.mjs +147 -2
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/server.CN0534_m.d.mts +18 -0
- package/dist/shared/{server.Cud5qk0c.d.ts → server.CjlA3NKP.d.ts} +2 -2
- package/dist/shared/server.CuD15qZB.d.ts +18 -0
- package/dist/shared/{server.BHlRCrf_.d.ts → server.D5fBlF9j.d.ts} +13 -5
- 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.CzxlqYZL.d.mts → server.DY7OKEoj.d.mts} +13 -5
- package/dist/shared/{server.DGnN7q3R.d.mts → server.DjgtLwKi.d.mts} +2 -2
- package/dist/shared/{server.DCCkTG29.mjs → server.qf03T-Xn.mjs} +35 -7
- package/package.json +8 -22
- 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';
|
@@ -57,18 +57,38 @@ function createActionableClient(client) {
|
|
57
57
|
}
|
58
58
|
|
59
59
|
class DecoratedProcedure extends Procedure {
|
60
|
+
/**
|
61
|
+
* Adds type-safe custom errors.
|
62
|
+
* The provided errors are spared-merged with any existing errors.
|
63
|
+
*
|
64
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
65
|
+
*/
|
60
66
|
errors(errors) {
|
61
67
|
return new DecoratedProcedure({
|
62
68
|
...this["~orpc"],
|
63
69
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
64
70
|
});
|
65
71
|
}
|
72
|
+
/**
|
73
|
+
* Sets or updates the metadata.
|
74
|
+
* The provided metadata is spared-merged with any existing metadata.
|
75
|
+
*
|
76
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
77
|
+
*/
|
66
78
|
meta(meta) {
|
67
79
|
return new DecoratedProcedure({
|
68
80
|
...this["~orpc"],
|
69
81
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
70
82
|
});
|
71
83
|
}
|
84
|
+
/**
|
85
|
+
* Sets or updates the route definition.
|
86
|
+
* The provided route is spared-merged with any existing route.
|
87
|
+
* This option is typically relevant when integrating with OpenAPI.
|
88
|
+
*
|
89
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
90
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
91
|
+
*/
|
72
92
|
route(route) {
|
73
93
|
return new DecoratedProcedure({
|
74
94
|
...this["~orpc"],
|
@@ -84,6 +104,8 @@ class DecoratedProcedure extends Procedure {
|
|
84
104
|
}
|
85
105
|
/**
|
86
106
|
* Make this procedure callable (works like a function while still being a procedure).
|
107
|
+
*
|
108
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
87
109
|
*/
|
88
110
|
callable(...rest) {
|
89
111
|
const client = createProcedureClient(this, ...rest);
|
@@ -98,6 +120,8 @@ class DecoratedProcedure extends Procedure {
|
|
98
120
|
}
|
99
121
|
/**
|
100
122
|
* Make this procedure compatible with server action.
|
123
|
+
*
|
124
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
101
125
|
*/
|
102
126
|
actionable(...rest) {
|
103
127
|
const action = createActionableClient(createProcedureClient(this, ...rest));
|
@@ -113,12 +137,18 @@ class DecoratedProcedure extends Procedure {
|
|
113
137
|
}
|
114
138
|
|
115
139
|
class Builder {
|
140
|
+
/**
|
141
|
+
* This property holds the defined options.
|
142
|
+
*/
|
116
143
|
"~orpc";
|
117
144
|
constructor(def) {
|
118
145
|
this["~orpc"] = def;
|
119
146
|
}
|
120
147
|
/**
|
121
|
-
*
|
148
|
+
* Sets or overrides the config.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
|
151
|
+
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
122
152
|
*/
|
123
153
|
$config(config) {
|
124
154
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
@@ -132,7 +162,9 @@ class Builder {
|
|
132
162
|
});
|
133
163
|
}
|
134
164
|
/**
|
135
|
-
*
|
165
|
+
* Set or override the initial context.
|
166
|
+
*
|
167
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
136
168
|
*/
|
137
169
|
$context() {
|
138
170
|
return new Builder({
|
@@ -143,7 +175,9 @@ class Builder {
|
|
143
175
|
});
|
144
176
|
}
|
145
177
|
/**
|
146
|
-
*
|
178
|
+
* Sets or overrides the initial meta.
|
179
|
+
*
|
180
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
147
181
|
*/
|
148
182
|
$meta(initialMeta) {
|
149
183
|
return new Builder({
|
@@ -152,7 +186,11 @@ class Builder {
|
|
152
186
|
});
|
153
187
|
}
|
154
188
|
/**
|
155
|
-
*
|
189
|
+
* Sets or overrides the initial route.
|
190
|
+
* This option is typically relevant when integrating with OpenAPI.
|
191
|
+
*
|
192
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
193
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
156
194
|
*/
|
157
195
|
$route(initialRoute) {
|
158
196
|
return new Builder({
|
@@ -160,15 +198,31 @@ class Builder {
|
|
160
198
|
route: initialRoute
|
161
199
|
});
|
162
200
|
}
|
201
|
+
/**
|
202
|
+
* Sets or overrides the initial input schema.
|
203
|
+
*
|
204
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
|
205
|
+
*/
|
163
206
|
$input(initialInputSchema) {
|
164
207
|
return new Builder({
|
165
208
|
...this["~orpc"],
|
166
209
|
inputSchema: initialInputSchema
|
167
210
|
});
|
168
211
|
}
|
212
|
+
/**
|
213
|
+
* Creates a middleware.
|
214
|
+
*
|
215
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
216
|
+
*/
|
169
217
|
middleware(middleware) {
|
170
218
|
return decorateMiddleware(middleware);
|
171
219
|
}
|
220
|
+
/**
|
221
|
+
* Adds type-safe custom errors.
|
222
|
+
* The provided errors are spared-merged with any existing errors.
|
223
|
+
*
|
224
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
225
|
+
*/
|
172
226
|
errors(errors) {
|
173
227
|
return new Builder({
|
174
228
|
...this["~orpc"],
|
@@ -182,18 +236,37 @@ class Builder {
|
|
182
236
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
183
237
|
});
|
184
238
|
}
|
239
|
+
/**
|
240
|
+
* Sets or updates the metadata.
|
241
|
+
* The provided metadata is spared-merged with any existing metadata.
|
242
|
+
*
|
243
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
244
|
+
*/
|
185
245
|
meta(meta) {
|
186
246
|
return new Builder({
|
187
247
|
...this["~orpc"],
|
188
248
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
189
249
|
});
|
190
250
|
}
|
251
|
+
/**
|
252
|
+
* Sets or updates the route definition.
|
253
|
+
* The provided route is spared-merged with any existing route.
|
254
|
+
* This option is typically relevant when integrating with OpenAPI.
|
255
|
+
*
|
256
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
257
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
258
|
+
*/
|
191
259
|
route(route) {
|
192
260
|
return new Builder({
|
193
261
|
...this["~orpc"],
|
194
262
|
route: mergeRoute(this["~orpc"].route, route)
|
195
263
|
});
|
196
264
|
}
|
265
|
+
/**
|
266
|
+
* Defines the input validation schema.
|
267
|
+
*
|
268
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
269
|
+
*/
|
197
270
|
input(schema) {
|
198
271
|
return new Builder({
|
199
272
|
...this["~orpc"],
|
@@ -201,6 +274,11 @@ class Builder {
|
|
201
274
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
202
275
|
});
|
203
276
|
}
|
277
|
+
/**
|
278
|
+
* Defines the output validation schema.
|
279
|
+
*
|
280
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
281
|
+
*/
|
204
282
|
output(schema) {
|
205
283
|
return new Builder({
|
206
284
|
...this["~orpc"],
|
@@ -208,27 +286,57 @@ class Builder {
|
|
208
286
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
209
287
|
});
|
210
288
|
}
|
289
|
+
/**
|
290
|
+
* Defines the handler of the procedure.
|
291
|
+
*
|
292
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
293
|
+
*/
|
211
294
|
handler(handler) {
|
212
295
|
return new DecoratedProcedure({
|
213
296
|
...this["~orpc"],
|
214
297
|
handler
|
215
298
|
});
|
216
299
|
}
|
300
|
+
/**
|
301
|
+
* Prefixes all procedures in the router.
|
302
|
+
* The provided prefix is post-appended to any existing router prefix.
|
303
|
+
*
|
304
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
305
|
+
*
|
306
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
307
|
+
*/
|
217
308
|
prefix(prefix) {
|
218
309
|
return new Builder({
|
219
310
|
...this["~orpc"],
|
220
311
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
221
312
|
});
|
222
313
|
}
|
314
|
+
/**
|
315
|
+
* Adds tags to all procedures in the router.
|
316
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
317
|
+
*
|
318
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
319
|
+
*/
|
223
320
|
tag(...tags) {
|
224
321
|
return new Builder({
|
225
322
|
...this["~orpc"],
|
226
323
|
tags: mergeTags(this["~orpc"].tags, tags)
|
227
324
|
});
|
228
325
|
}
|
326
|
+
/**
|
327
|
+
* Applies all of the previously defined options to the specified router.
|
328
|
+
*
|
329
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
330
|
+
*/
|
229
331
|
router(router) {
|
230
332
|
return enhanceRouter(router, this["~orpc"]);
|
231
333
|
}
|
334
|
+
/**
|
335
|
+
* Create a lazy router
|
336
|
+
* And applies all of the previously defined options to the specified router.
|
337
|
+
*
|
338
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
339
|
+
*/
|
232
340
|
lazy(loader) {
|
233
341
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
234
342
|
}
|
@@ -336,12 +444,12 @@ function implement(contract, config = {}) {
|
|
336
444
|
return impl;
|
337
445
|
}
|
338
446
|
|
339
|
-
function createRouterClient(router, ...
|
447
|
+
function createRouterClient(router, ...rest) {
|
340
448
|
if (isProcedure(router)) {
|
341
|
-
const caller = createProcedureClient(router,
|
449
|
+
const caller = createProcedureClient(router, ...rest);
|
342
450
|
return caller;
|
343
451
|
}
|
344
|
-
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router),
|
452
|
+
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), ...rest) : {};
|
345
453
|
const recursive = new Proxy(procedureCaller, {
|
346
454
|
get(target, key) {
|
347
455
|
if (typeof key !== "string") {
|
@@ -352,8 +460,8 @@ function createRouterClient(router, ...[options]) {
|
|
352
460
|
return Reflect.get(target, key);
|
353
461
|
}
|
354
462
|
return createRouterClient(next, {
|
355
|
-
...
|
356
|
-
path: [...
|
463
|
+
...rest[0],
|
464
|
+
path: [...rest[0]?.path ?? [], key]
|
357
465
|
});
|
358
466
|
}
|
359
467
|
});
|
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.DY7OKEoj.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.D5fBlF9j.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 };
|