@orpc/server 0.0.0-next.b45a533 → 0.0.0-next.b47b94e
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 +25 -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 +62 -10
- package/dist/adapters/fetch/index.d.ts +62 -10
- package/dist/adapters/fetch/index.mjs +109 -8
- package/dist/adapters/node/index.d.mts +64 -21
- package/dist/adapters/node/index.d.ts +64 -21
- package/dist/adapters/node/index.mjs +87 -23
- package/dist/adapters/standard/index.d.mts +11 -10
- package/dist/adapters/standard/index.d.ts +11 -10
- 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 +602 -51
- package/dist/index.d.ts +602 -51
- package/dist/index.mjs +147 -19
- package/dist/plugins/index.d.mts +140 -15
- package/dist/plugins/index.d.ts +140 -15
- package/dist/plugins/index.mjs +162 -14
- package/dist/shared/server.BRoxSiSC.d.mts +12 -0
- package/dist/shared/server.BVwwTHyO.mjs +9 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/server.BjiJH9Vo.d.ts +10 -0
- package/dist/shared/server.Cy1vfSiG.d.ts +12 -0
- package/dist/shared/{server.B_5ZADvP.mjs → server.DG7Tamti.mjs} +26 -22
- package/dist/shared/{server.DnmJuN02.d.mts → server.DPWk5pjW.d.mts} +61 -13
- package/dist/shared/{server.DnmJuN02.d.ts → server.DPWk5pjW.d.ts} +61 -13
- package/dist/shared/server.QUe9N8P4.d.mts +10 -0
- package/dist/shared/{server.3mOimouH.mjs → server.SxlTJfG2.mjs} +55 -30
- package/dist/shared/server.YZzrREz9.d.ts +74 -0
- package/dist/shared/server.eWLxY3lq.d.mts +74 -0
- package/package.json +43 -20
- package/dist/adapters/hono/index.d.mts +0 -19
- package/dist/adapters/hono/index.d.ts +0 -19
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -26
- package/dist/adapters/next/index.d.ts +0 -26
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.BgDZnmUZ.mjs +0 -28
- package/dist/shared/server.CL84X8p4.d.mts +0 -75
- package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
- package/dist/shared/server.hqPWnakL.d.ts +0 -75
package/dist/index.mjs
CHANGED
@@ -1,7 +1,8 @@
|
|
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,
|
4
|
-
export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter,
|
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
|
+
import { toORPCError } from '@orpc/client';
|
5
6
|
export { ORPCError, isDefinedError, safe } from '@orpc/client';
|
6
7
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
7
8
|
export { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
@@ -44,19 +45,53 @@ function decorateMiddleware(middleware) {
|
|
44
45
|
return decorated;
|
45
46
|
}
|
46
47
|
|
48
|
+
function createActionableClient(client) {
|
49
|
+
const action = async (input) => {
|
50
|
+
try {
|
51
|
+
return [null, await client(input)];
|
52
|
+
} catch (error) {
|
53
|
+
if (error instanceof Error && "digest" in error && typeof error.digest === "string" && error.digest.startsWith("NEXT_")) {
|
54
|
+
throw error;
|
55
|
+
}
|
56
|
+
return [toORPCError(error).toJSON(), void 0];
|
57
|
+
}
|
58
|
+
};
|
59
|
+
return action;
|
60
|
+
}
|
61
|
+
|
47
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
|
+
*/
|
48
69
|
errors(errors) {
|
49
70
|
return new DecoratedProcedure({
|
50
71
|
...this["~orpc"],
|
51
72
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
52
73
|
});
|
53
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
|
+
*/
|
54
81
|
meta(meta) {
|
55
82
|
return new DecoratedProcedure({
|
56
83
|
...this["~orpc"],
|
57
84
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
58
85
|
});
|
59
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
|
+
*/
|
60
95
|
route(route) {
|
61
96
|
return new DecoratedProcedure({
|
62
97
|
...this["~orpc"],
|
@@ -72,9 +107,12 @@ class DecoratedProcedure extends Procedure {
|
|
72
107
|
}
|
73
108
|
/**
|
74
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}
|
75
112
|
*/
|
76
113
|
callable(...rest) {
|
77
|
-
|
114
|
+
const client = createProcedureClient(this, ...rest);
|
115
|
+
return new Proxy(client, {
|
78
116
|
get: (target, key) => {
|
79
117
|
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
80
118
|
},
|
@@ -84,20 +122,36 @@ class DecoratedProcedure extends Procedure {
|
|
84
122
|
});
|
85
123
|
}
|
86
124
|
/**
|
87
|
-
* Make this procedure compatible with server action
|
125
|
+
* Make this procedure compatible with server action.
|
126
|
+
*
|
127
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
88
128
|
*/
|
89
129
|
actionable(...rest) {
|
90
|
-
|
130
|
+
const action = createActionableClient(createProcedureClient(this, ...rest));
|
131
|
+
return new Proxy(action, {
|
132
|
+
get: (target, key) => {
|
133
|
+
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
134
|
+
},
|
135
|
+
has: (target, key) => {
|
136
|
+
return Reflect.has(this, key) || Reflect.has(target, key);
|
137
|
+
}
|
138
|
+
});
|
91
139
|
}
|
92
140
|
}
|
93
141
|
|
94
142
|
class Builder {
|
143
|
+
/**
|
144
|
+
* This property holds the defined options.
|
145
|
+
*/
|
95
146
|
"~orpc";
|
96
147
|
constructor(def) {
|
97
148
|
this["~orpc"] = def;
|
98
149
|
}
|
99
150
|
/**
|
100
|
-
*
|
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}
|
101
155
|
*/
|
102
156
|
$config(config) {
|
103
157
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
@@ -111,7 +165,9 @@ class Builder {
|
|
111
165
|
});
|
112
166
|
}
|
113
167
|
/**
|
114
|
-
*
|
168
|
+
* Set or override the initial context.
|
169
|
+
*
|
170
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
115
171
|
*/
|
116
172
|
$context() {
|
117
173
|
return new Builder({
|
@@ -122,7 +178,9 @@ class Builder {
|
|
122
178
|
});
|
123
179
|
}
|
124
180
|
/**
|
125
|
-
*
|
181
|
+
* Sets or overrides the initial meta.
|
182
|
+
*
|
183
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
126
184
|
*/
|
127
185
|
$meta(initialMeta) {
|
128
186
|
return new Builder({
|
@@ -131,7 +189,11 @@ class Builder {
|
|
131
189
|
});
|
132
190
|
}
|
133
191
|
/**
|
134
|
-
*
|
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}
|
135
197
|
*/
|
136
198
|
$route(initialRoute) {
|
137
199
|
return new Builder({
|
@@ -139,15 +201,31 @@ class Builder {
|
|
139
201
|
route: initialRoute
|
140
202
|
});
|
141
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
|
+
*/
|
142
209
|
$input(initialInputSchema) {
|
143
210
|
return new Builder({
|
144
211
|
...this["~orpc"],
|
145
212
|
inputSchema: initialInputSchema
|
146
213
|
});
|
147
214
|
}
|
215
|
+
/**
|
216
|
+
* Creates a middleware.
|
217
|
+
*
|
218
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
219
|
+
*/
|
148
220
|
middleware(middleware) {
|
149
221
|
return decorateMiddleware(middleware);
|
150
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
|
+
*/
|
151
229
|
errors(errors) {
|
152
230
|
return new Builder({
|
153
231
|
...this["~orpc"],
|
@@ -161,18 +239,37 @@ class Builder {
|
|
161
239
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
162
240
|
});
|
163
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
|
+
*/
|
164
248
|
meta(meta) {
|
165
249
|
return new Builder({
|
166
250
|
...this["~orpc"],
|
167
251
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
168
252
|
});
|
169
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
|
+
*/
|
170
262
|
route(route) {
|
171
263
|
return new Builder({
|
172
264
|
...this["~orpc"],
|
173
265
|
route: mergeRoute(this["~orpc"].route, route)
|
174
266
|
});
|
175
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
|
+
*/
|
176
273
|
input(schema) {
|
177
274
|
return new Builder({
|
178
275
|
...this["~orpc"],
|
@@ -180,6 +277,11 @@ class Builder {
|
|
180
277
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
181
278
|
});
|
182
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
|
+
*/
|
183
285
|
output(schema) {
|
184
286
|
return new Builder({
|
185
287
|
...this["~orpc"],
|
@@ -187,27 +289,57 @@ class Builder {
|
|
187
289
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
188
290
|
});
|
189
291
|
}
|
292
|
+
/**
|
293
|
+
* Defines the handler of the procedure.
|
294
|
+
*
|
295
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
296
|
+
*/
|
190
297
|
handler(handler) {
|
191
298
|
return new DecoratedProcedure({
|
192
299
|
...this["~orpc"],
|
193
300
|
handler
|
194
301
|
});
|
195
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
|
+
*/
|
196
311
|
prefix(prefix) {
|
197
312
|
return new Builder({
|
198
313
|
...this["~orpc"],
|
199
314
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
200
315
|
});
|
201
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
|
+
*/
|
202
323
|
tag(...tags) {
|
203
324
|
return new Builder({
|
204
325
|
...this["~orpc"],
|
205
326
|
tags: mergeTags(this["~orpc"].tags, tags)
|
206
327
|
});
|
207
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
|
+
*/
|
208
334
|
router(router) {
|
209
335
|
return enhanceRouter(router, this["~orpc"]);
|
210
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
|
+
*/
|
211
343
|
lazy(loader) {
|
212
344
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
213
345
|
}
|
@@ -223,10 +355,6 @@ const os = new Builder({
|
|
223
355
|
dedupeLeadingMiddlewares: true
|
224
356
|
});
|
225
357
|
|
226
|
-
function mergeCurrentContext(context, other) {
|
227
|
-
return { ...context, ...other };
|
228
|
-
}
|
229
|
-
|
230
358
|
function implementerInternal(contract, config, middlewares) {
|
231
359
|
if (isContractProcedure(contract)) {
|
232
360
|
const impl2 = new Builder({
|
@@ -319,12 +447,12 @@ function implement(contract, config = {}) {
|
|
319
447
|
return impl;
|
320
448
|
}
|
321
449
|
|
322
|
-
function createRouterClient(router, ...
|
450
|
+
function createRouterClient(router, ...rest) {
|
323
451
|
if (isProcedure(router)) {
|
324
|
-
const caller = createProcedureClient(router,
|
452
|
+
const caller = createProcedureClient(router, ...rest);
|
325
453
|
return caller;
|
326
454
|
}
|
327
|
-
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router),
|
455
|
+
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), ...rest) : {};
|
328
456
|
const recursive = new Proxy(procedureCaller, {
|
329
457
|
get(target, key) {
|
330
458
|
if (typeof key !== "string") {
|
@@ -335,12 +463,12 @@ function createRouterClient(router, ...[options]) {
|
|
335
463
|
return Reflect.get(target, key);
|
336
464
|
}
|
337
465
|
return createRouterClient(next, {
|
338
|
-
...
|
339
|
-
path: [...
|
466
|
+
...rest[0],
|
467
|
+
path: [...rest[0]?.path ?? [], key]
|
340
468
|
});
|
341
469
|
}
|
342
470
|
});
|
343
471
|
return recursive;
|
344
472
|
}
|
345
473
|
|
346
|
-
export { Builder, DecoratedProcedure, Procedure, addMiddleware, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy,
|
474
|
+
export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy, os, setHiddenRouterContract };
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,31 +1,156 @@
|
|
1
|
-
import { a as StandardHandlerInterceptorOptions, H as HandlerPlugin, b as StandardHandlerOptions } from '../shared/server.CL84X8p4.mjs';
|
2
|
-
export { C as CompositePlugin } from '../shared/server.CL84X8p4.mjs';
|
3
1
|
import { Value } from '@orpc/shared';
|
4
|
-
import {
|
5
|
-
import '@orpc/
|
6
|
-
import '
|
7
|
-
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
8
|
|
9
|
-
interface
|
10
|
-
|
11
|
-
|
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
|
+
}
|
50
|
+
|
51
|
+
interface CORSOptions<T extends Context> {
|
52
|
+
origin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
53
|
+
timingOrigin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
12
54
|
allowMethods?: readonly string[];
|
13
55
|
allowHeaders?: readonly string[];
|
14
56
|
maxAge?: number;
|
15
57
|
credentials?: boolean;
|
16
58
|
exposeHeaders?: readonly string[];
|
17
59
|
}
|
18
|
-
|
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
|
+
*/
|
65
|
+
declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
19
66
|
private readonly options;
|
20
|
-
|
21
|
-
|
67
|
+
order: number;
|
68
|
+
constructor(options?: CORSOptions<T>);
|
69
|
+
init(options: StandardHandlerOptions<T>): void;
|
22
70
|
}
|
23
71
|
|
24
72
|
interface ResponseHeadersPluginContext {
|
25
73
|
resHeaders?: Headers;
|
26
74
|
}
|
27
|
-
|
28
|
-
|
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
|
+
*/
|
81
|
+
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
82
|
+
init(options: StandardHandlerOptions<T>): void;
|
83
|
+
}
|
84
|
+
|
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;
|
29
153
|
}
|
30
154
|
|
31
|
-
export {
|
155
|
+
export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
156
|
+
export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,31 +1,156 @@
|
|
1
|
-
import { a as StandardHandlerInterceptorOptions, H as HandlerPlugin, b as StandardHandlerOptions } from '../shared/server.hqPWnakL.js';
|
2
|
-
export { C as CompositePlugin } from '../shared/server.hqPWnakL.js';
|
3
1
|
import { Value } from '@orpc/shared';
|
4
|
-
import {
|
5
|
-
import '@orpc/
|
6
|
-
import '
|
7
|
-
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
8
|
|
9
|
-
interface
|
10
|
-
|
11
|
-
|
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
|
+
}
|
50
|
+
|
51
|
+
interface CORSOptions<T extends Context> {
|
52
|
+
origin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
53
|
+
timingOrigin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
12
54
|
allowMethods?: readonly string[];
|
13
55
|
allowHeaders?: readonly string[];
|
14
56
|
maxAge?: number;
|
15
57
|
credentials?: boolean;
|
16
58
|
exposeHeaders?: readonly string[];
|
17
59
|
}
|
18
|
-
|
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
|
+
*/
|
65
|
+
declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
19
66
|
private readonly options;
|
20
|
-
|
21
|
-
|
67
|
+
order: number;
|
68
|
+
constructor(options?: CORSOptions<T>);
|
69
|
+
init(options: StandardHandlerOptions<T>): void;
|
22
70
|
}
|
23
71
|
|
24
72
|
interface ResponseHeadersPluginContext {
|
25
73
|
resHeaders?: Headers;
|
26
74
|
}
|
27
|
-
|
28
|
-
|
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
|
+
*/
|
81
|
+
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
82
|
+
init(options: StandardHandlerOptions<T>): void;
|
83
|
+
}
|
84
|
+
|
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;
|
29
153
|
}
|
30
154
|
|
31
|
-
export {
|
155
|
+
export { BatchHandlerPlugin, CORSPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
156
|
+
export type { BatchHandlerOptions, CORSOptions, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|