@orpc/server 0.0.0-next.9b9ade5 → 0.0.0-next.9cd157a
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/fetch/index.d.mts +54 -10
- package/dist/adapters/fetch/index.d.ts +54 -10
- package/dist/adapters/fetch/index.mjs +104 -8
- package/dist/adapters/node/index.d.mts +56 -21
- package/dist/adapters/node/index.d.ts +56 -21
- package/dist/adapters/node/index.mjs +82 -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 +6 -4
- package/dist/index.d.mts +625 -65
- package/dist/index.d.ts +625 -65
- package/dist/index.mjs +165 -34
- package/dist/plugins/index.d.mts +140 -15
- package/dist/plugins/index.d.ts +140 -15
- package/dist/plugins/index.mjs +156 -7
- package/dist/shared/{server.CSZRzcSW.mjs → server.BM1HMJGg.mjs} +62 -30
- 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.CzSMXd8y.d.mts +18 -0
- package/dist/shared/server.DEgjJVit.d.ts +18 -0
- package/dist/shared/{server.CMrS28Go.mjs → server.DG7Tamti.mjs} +45 -24
- package/dist/shared/{server.CPteJIPP.d.mts → server.DPWk5pjW.d.mts} +71 -22
- package/dist/shared/{server.CPteJIPP.d.ts → server.DPWk5pjW.d.ts} +71 -22
- package/dist/shared/server.QUe9N8P4.d.mts +10 -0
- package/dist/shared/server.YZzrREz9.d.ts +74 -0
- package/dist/shared/server.eWLxY3lq.d.mts +74 -0
- package/package.json +9 -22
- 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.CM3tWr3C.d.mts +0 -75
- package/dist/shared/server.Cq3B6PoL.mjs +0 -28
- package/dist/shared/server.DmW25ynm.d.ts +0 -75
- package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
package/dist/index.mjs
CHANGED
@@ -1,14 +1,16 @@
|
|
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,
|
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';
|
8
9
|
|
9
10
|
const DEFAULT_CONFIG = {
|
10
11
|
initialInputValidationIndex: 0,
|
11
|
-
initialOutputValidationIndex: 0
|
12
|
+
initialOutputValidationIndex: 0,
|
13
|
+
dedupeLeadingMiddlewares: true
|
12
14
|
};
|
13
15
|
function fallbackConfig(key, value) {
|
14
16
|
if (value === void 0) {
|
@@ -43,19 +45,53 @@ function decorateMiddleware(middleware) {
|
|
43
45
|
return decorated;
|
44
46
|
}
|
45
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
|
+
|
46
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
|
+
*/
|
47
69
|
errors(errors) {
|
48
70
|
return new DecoratedProcedure({
|
49
71
|
...this["~orpc"],
|
50
72
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
51
73
|
});
|
52
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
|
+
*/
|
53
81
|
meta(meta) {
|
54
82
|
return new DecoratedProcedure({
|
55
83
|
...this["~orpc"],
|
56
84
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
57
85
|
});
|
58
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
|
+
*/
|
59
95
|
route(route) {
|
60
96
|
return new DecoratedProcedure({
|
61
97
|
...this["~orpc"],
|
@@ -71,9 +107,12 @@ class DecoratedProcedure extends Procedure {
|
|
71
107
|
}
|
72
108
|
/**
|
73
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}
|
74
112
|
*/
|
75
113
|
callable(...rest) {
|
76
|
-
|
114
|
+
const client = createProcedureClient(this, ...rest);
|
115
|
+
return new Proxy(client, {
|
77
116
|
get: (target, key) => {
|
78
117
|
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
79
118
|
},
|
@@ -83,20 +122,36 @@ class DecoratedProcedure extends Procedure {
|
|
83
122
|
});
|
84
123
|
}
|
85
124
|
/**
|
86
|
-
* 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}
|
87
128
|
*/
|
88
129
|
actionable(...rest) {
|
89
|
-
|
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
|
+
});
|
90
139
|
}
|
91
140
|
}
|
92
141
|
|
93
142
|
class Builder {
|
143
|
+
/**
|
144
|
+
* This property holds the defined options.
|
145
|
+
*/
|
94
146
|
"~orpc";
|
95
147
|
constructor(def) {
|
96
148
|
this["~orpc"] = def;
|
97
149
|
}
|
98
150
|
/**
|
99
|
-
*
|
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}
|
100
155
|
*/
|
101
156
|
$config(config) {
|
102
157
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
@@ -104,12 +159,15 @@ class Builder {
|
|
104
159
|
return new Builder({
|
105
160
|
...this["~orpc"],
|
106
161
|
config,
|
162
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares),
|
107
163
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config.initialInputValidationIndex) + inputValidationCount,
|
108
164
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config.initialOutputValidationIndex) + outputValidationCount
|
109
165
|
});
|
110
166
|
}
|
111
167
|
/**
|
112
|
-
*
|
168
|
+
* Set or override the initial context.
|
169
|
+
*
|
170
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
113
171
|
*/
|
114
172
|
$context() {
|
115
173
|
return new Builder({
|
@@ -120,7 +178,9 @@ class Builder {
|
|
120
178
|
});
|
121
179
|
}
|
122
180
|
/**
|
123
|
-
*
|
181
|
+
* Sets or overrides the initial meta.
|
182
|
+
*
|
183
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
124
184
|
*/
|
125
185
|
$meta(initialMeta) {
|
126
186
|
return new Builder({
|
@@ -129,7 +189,11 @@ class Builder {
|
|
129
189
|
});
|
130
190
|
}
|
131
191
|
/**
|
132
|
-
*
|
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}
|
133
197
|
*/
|
134
198
|
$route(initialRoute) {
|
135
199
|
return new Builder({
|
@@ -137,15 +201,31 @@ class Builder {
|
|
137
201
|
route: initialRoute
|
138
202
|
});
|
139
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
|
+
*/
|
140
209
|
$input(initialInputSchema) {
|
141
210
|
return new Builder({
|
142
211
|
...this["~orpc"],
|
143
212
|
inputSchema: initialInputSchema
|
144
213
|
});
|
145
214
|
}
|
215
|
+
/**
|
216
|
+
* Creates a middleware.
|
217
|
+
*
|
218
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
219
|
+
*/
|
146
220
|
middleware(middleware) {
|
147
221
|
return decorateMiddleware(middleware);
|
148
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
|
+
*/
|
149
229
|
errors(errors) {
|
150
230
|
return new Builder({
|
151
231
|
...this["~orpc"],
|
@@ -159,18 +239,37 @@ class Builder {
|
|
159
239
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
160
240
|
});
|
161
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
|
+
*/
|
162
248
|
meta(meta) {
|
163
249
|
return new Builder({
|
164
250
|
...this["~orpc"],
|
165
251
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
166
252
|
});
|
167
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
|
+
*/
|
168
262
|
route(route) {
|
169
263
|
return new Builder({
|
170
264
|
...this["~orpc"],
|
171
265
|
route: mergeRoute(this["~orpc"].route, route)
|
172
266
|
});
|
173
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
|
+
*/
|
174
273
|
input(schema) {
|
175
274
|
return new Builder({
|
176
275
|
...this["~orpc"],
|
@@ -178,6 +277,11 @@ class Builder {
|
|
178
277
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
179
278
|
});
|
180
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
|
+
*/
|
181
285
|
output(schema) {
|
182
286
|
return new Builder({
|
183
287
|
...this["~orpc"],
|
@@ -185,27 +289,57 @@ class Builder {
|
|
185
289
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
186
290
|
});
|
187
291
|
}
|
292
|
+
/**
|
293
|
+
* Defines the handler of the procedure.
|
294
|
+
*
|
295
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
296
|
+
*/
|
188
297
|
handler(handler) {
|
189
298
|
return new DecoratedProcedure({
|
190
299
|
...this["~orpc"],
|
191
300
|
handler
|
192
301
|
});
|
193
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
|
+
*/
|
194
311
|
prefix(prefix) {
|
195
312
|
return new Builder({
|
196
313
|
...this["~orpc"],
|
197
314
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
198
315
|
});
|
199
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
|
+
*/
|
200
323
|
tag(...tags) {
|
201
324
|
return new Builder({
|
202
325
|
...this["~orpc"],
|
203
326
|
tags: mergeTags(this["~orpc"].tags, tags)
|
204
327
|
});
|
205
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
|
+
*/
|
206
334
|
router(router) {
|
207
335
|
return enhanceRouter(router, this["~orpc"]);
|
208
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
|
+
*/
|
209
343
|
lazy(loader) {
|
210
344
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
211
345
|
}
|
@@ -217,13 +351,10 @@ const os = new Builder({
|
|
217
351
|
errorMap: {},
|
218
352
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex"),
|
219
353
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex"),
|
220
|
-
middlewares: []
|
354
|
+
middlewares: [],
|
355
|
+
dedupeLeadingMiddlewares: true
|
221
356
|
});
|
222
357
|
|
223
|
-
function mergeContext(context, other) {
|
224
|
-
return { ...context, ...other };
|
225
|
-
}
|
226
|
-
|
227
358
|
function implementerInternal(contract, config, middlewares) {
|
228
359
|
if (isContractProcedure(contract)) {
|
229
360
|
const impl2 = new Builder({
|
@@ -231,7 +362,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
231
362
|
config,
|
232
363
|
middlewares,
|
233
364
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config?.initialInputValidationIndex) + middlewares.length,
|
234
|
-
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length
|
365
|
+
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length,
|
366
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
235
367
|
});
|
236
368
|
return impl2;
|
237
369
|
}
|
@@ -257,7 +389,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
257
389
|
middlewares,
|
258
390
|
errorMap: {},
|
259
391
|
prefix: void 0,
|
260
|
-
tags: void 0
|
392
|
+
tags: void 0,
|
393
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
261
394
|
});
|
262
395
|
return setHiddenRouterContract(adapted, contract);
|
263
396
|
};
|
@@ -267,7 +400,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
267
400
|
middlewares,
|
268
401
|
errorMap: {},
|
269
402
|
prefix: void 0,
|
270
|
-
tags: void 0
|
403
|
+
tags: void 0,
|
404
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
271
405
|
});
|
272
406
|
return setHiddenRouterContract(adapted, contract);
|
273
407
|
};
|
@@ -300,28 +434,25 @@ function implement(contract, config = {}) {
|
|
300
434
|
method = (config2) => implement(contract, config2);
|
301
435
|
}
|
302
436
|
const next = Reflect.get(target, key);
|
303
|
-
if (!next || typeof next !== "function" && typeof next !== "object") {
|
304
|
-
return method
|
437
|
+
if (!method || !next || typeof next !== "function" && typeof next !== "object") {
|
438
|
+
return method || next;
|
305
439
|
}
|
306
|
-
|
307
|
-
|
308
|
-
get(
|
309
|
-
|
310
|
-
|
311
|
-
});
|
312
|
-
}
|
313
|
-
return next;
|
440
|
+
return new Proxy(method, {
|
441
|
+
get(_, key2) {
|
442
|
+
return Reflect.get(next, key2);
|
443
|
+
}
|
444
|
+
});
|
314
445
|
}
|
315
446
|
});
|
316
447
|
return impl;
|
317
448
|
}
|
318
449
|
|
319
|
-
function createRouterClient(router, ...
|
450
|
+
function createRouterClient(router, ...rest) {
|
320
451
|
if (isProcedure(router)) {
|
321
|
-
const caller = createProcedureClient(router,
|
452
|
+
const caller = createProcedureClient(router, ...rest);
|
322
453
|
return caller;
|
323
454
|
}
|
324
|
-
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router),
|
455
|
+
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), ...rest) : {};
|
325
456
|
const recursive = new Proxy(procedureCaller, {
|
326
457
|
get(target, key) {
|
327
458
|
if (typeof key !== "string") {
|
@@ -332,12 +463,12 @@ function createRouterClient(router, ...[options]) {
|
|
332
463
|
return Reflect.get(target, key);
|
333
464
|
}
|
334
465
|
return createRouterClient(next, {
|
335
|
-
...
|
336
|
-
path: [...
|
466
|
+
...rest[0],
|
467
|
+
path: [...rest[0]?.path ?? [], key]
|
337
468
|
});
|
338
469
|
}
|
339
470
|
});
|
340
471
|
return recursive;
|
341
472
|
}
|
342
473
|
|
343
|
-
export { Builder, DecoratedProcedure, Procedure, 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.CM3tWr3C.mjs';
|
2
|
-
export { C as CompositePlugin } from '../shared/server.CM3tWr3C.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 };
|