@orpc/server 0.0.0-next.cc8802c → 0.0.0-next.cd10cfb
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 +28 -20
- package/dist/adapters/aws-lambda/index.d.mts +45 -0
- package/dist/adapters/aws-lambda/index.d.ts +45 -0
- package/dist/adapters/aws-lambda/index.mjs +41 -0
- 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 +51 -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 +51 -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/message-port/index.d.mts +28 -0
- package/dist/adapters/message-port/index.d.ts +28 -0
- package/dist/adapters/message-port/index.mjs +41 -0
- 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 +4 -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 +38 -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 +38 -0
- package/dist/index.d.mts +625 -65
- package/dist/index.d.ts +625 -65
- package/dist/index.mjs +167 -35
- package/dist/plugins/index.d.mts +141 -16
- package/dist/plugins/index.d.ts +141 -16
- package/dist/plugins/index.mjs +164 -14
- package/dist/shared/server.-ACo36I0.d.ts +74 -0
- package/dist/shared/server.BPAWobQg.d.ts +12 -0
- package/dist/shared/server.BVwwTHyO.mjs +9 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/server.Bd52nNaH.d.mts +12 -0
- package/dist/shared/server.BliFSTnG.d.mts +10 -0
- package/dist/shared/{server.CSZRzcSW.mjs → server.CHvOkcM3.mjs} +59 -31
- package/dist/shared/{server.CPteJIPP.d.mts → server.DD2C4ujN.d.mts} +73 -24
- package/dist/shared/{server.CPteJIPP.d.ts → server.DD2C4ujN.d.ts} +73 -24
- package/dist/shared/{server.CMrS28Go.mjs → server.DG7Tamti.mjs} +45 -24
- package/dist/shared/server.Dq8xr7PQ.d.mts +74 -0
- package/dist/shared/server.IG2MjhrD.d.ts +10 -0
- package/package.json +54 -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.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,17 @@
|
|
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
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
8
|
+
export { EventPublisher, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
7
9
|
export { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
8
10
|
|
9
11
|
const DEFAULT_CONFIG = {
|
10
12
|
initialInputValidationIndex: 0,
|
11
|
-
initialOutputValidationIndex: 0
|
13
|
+
initialOutputValidationIndex: 0,
|
14
|
+
dedupeLeadingMiddlewares: true
|
12
15
|
};
|
13
16
|
function fallbackConfig(key, value) {
|
14
17
|
if (value === void 0) {
|
@@ -43,19 +46,53 @@ function decorateMiddleware(middleware) {
|
|
43
46
|
return decorated;
|
44
47
|
}
|
45
48
|
|
49
|
+
function createActionableClient(client) {
|
50
|
+
const action = async (input) => {
|
51
|
+
try {
|
52
|
+
return [null, await client(input)];
|
53
|
+
} catch (error) {
|
54
|
+
if (error instanceof Error && "digest" in error && typeof error.digest === "string" && error.digest.startsWith("NEXT_")) {
|
55
|
+
throw error;
|
56
|
+
}
|
57
|
+
return [toORPCError(error).toJSON(), void 0];
|
58
|
+
}
|
59
|
+
};
|
60
|
+
return action;
|
61
|
+
}
|
62
|
+
|
46
63
|
class DecoratedProcedure extends Procedure {
|
64
|
+
/**
|
65
|
+
* Adds type-safe custom errors.
|
66
|
+
* The provided errors are spared-merged with any existing errors.
|
67
|
+
*
|
68
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
69
|
+
*/
|
47
70
|
errors(errors) {
|
48
71
|
return new DecoratedProcedure({
|
49
72
|
...this["~orpc"],
|
50
73
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
51
74
|
});
|
52
75
|
}
|
76
|
+
/**
|
77
|
+
* Sets or updates the metadata.
|
78
|
+
* The provided metadata is spared-merged with any existing metadata.
|
79
|
+
*
|
80
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
81
|
+
*/
|
53
82
|
meta(meta) {
|
54
83
|
return new DecoratedProcedure({
|
55
84
|
...this["~orpc"],
|
56
85
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
57
86
|
});
|
58
87
|
}
|
88
|
+
/**
|
89
|
+
* Sets or updates the route definition.
|
90
|
+
* The provided route is spared-merged with any existing route.
|
91
|
+
* This option is typically relevant when integrating with OpenAPI.
|
92
|
+
*
|
93
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
94
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
95
|
+
*/
|
59
96
|
route(route) {
|
60
97
|
return new DecoratedProcedure({
|
61
98
|
...this["~orpc"],
|
@@ -71,9 +108,12 @@ class DecoratedProcedure extends Procedure {
|
|
71
108
|
}
|
72
109
|
/**
|
73
110
|
* Make this procedure callable (works like a function while still being a procedure).
|
111
|
+
*
|
112
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
74
113
|
*/
|
75
114
|
callable(...rest) {
|
76
|
-
|
115
|
+
const client = createProcedureClient(this, ...rest);
|
116
|
+
return new Proxy(client, {
|
77
117
|
get: (target, key) => {
|
78
118
|
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
79
119
|
},
|
@@ -83,20 +123,36 @@ class DecoratedProcedure extends Procedure {
|
|
83
123
|
});
|
84
124
|
}
|
85
125
|
/**
|
86
|
-
* Make this procedure compatible with server action
|
126
|
+
* Make this procedure compatible with server action.
|
127
|
+
*
|
128
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
87
129
|
*/
|
88
130
|
actionable(...rest) {
|
89
|
-
|
131
|
+
const action = createActionableClient(createProcedureClient(this, ...rest));
|
132
|
+
return new Proxy(action, {
|
133
|
+
get: (target, key) => {
|
134
|
+
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
135
|
+
},
|
136
|
+
has: (target, key) => {
|
137
|
+
return Reflect.has(this, key) || Reflect.has(target, key);
|
138
|
+
}
|
139
|
+
});
|
90
140
|
}
|
91
141
|
}
|
92
142
|
|
93
143
|
class Builder {
|
144
|
+
/**
|
145
|
+
* This property holds the defined options.
|
146
|
+
*/
|
94
147
|
"~orpc";
|
95
148
|
constructor(def) {
|
96
149
|
this["~orpc"] = def;
|
97
150
|
}
|
98
151
|
/**
|
99
|
-
*
|
152
|
+
* Sets or overrides the config.
|
153
|
+
*
|
154
|
+
* @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
|
155
|
+
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
100
156
|
*/
|
101
157
|
$config(config) {
|
102
158
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
@@ -104,12 +160,15 @@ class Builder {
|
|
104
160
|
return new Builder({
|
105
161
|
...this["~orpc"],
|
106
162
|
config,
|
163
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares),
|
107
164
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config.initialInputValidationIndex) + inputValidationCount,
|
108
165
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config.initialOutputValidationIndex) + outputValidationCount
|
109
166
|
});
|
110
167
|
}
|
111
168
|
/**
|
112
|
-
*
|
169
|
+
* Set or override the initial context.
|
170
|
+
*
|
171
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
113
172
|
*/
|
114
173
|
$context() {
|
115
174
|
return new Builder({
|
@@ -120,7 +179,9 @@ class Builder {
|
|
120
179
|
});
|
121
180
|
}
|
122
181
|
/**
|
123
|
-
*
|
182
|
+
* Sets or overrides the initial meta.
|
183
|
+
*
|
184
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
124
185
|
*/
|
125
186
|
$meta(initialMeta) {
|
126
187
|
return new Builder({
|
@@ -129,7 +190,11 @@ class Builder {
|
|
129
190
|
});
|
130
191
|
}
|
131
192
|
/**
|
132
|
-
*
|
193
|
+
* Sets or overrides the initial route.
|
194
|
+
* This option is typically relevant when integrating with OpenAPI.
|
195
|
+
*
|
196
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
197
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
133
198
|
*/
|
134
199
|
$route(initialRoute) {
|
135
200
|
return new Builder({
|
@@ -137,15 +202,31 @@ class Builder {
|
|
137
202
|
route: initialRoute
|
138
203
|
});
|
139
204
|
}
|
205
|
+
/**
|
206
|
+
* Sets or overrides the initial input schema.
|
207
|
+
*
|
208
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
|
209
|
+
*/
|
140
210
|
$input(initialInputSchema) {
|
141
211
|
return new Builder({
|
142
212
|
...this["~orpc"],
|
143
213
|
inputSchema: initialInputSchema
|
144
214
|
});
|
145
215
|
}
|
216
|
+
/**
|
217
|
+
* Creates a middleware.
|
218
|
+
*
|
219
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
220
|
+
*/
|
146
221
|
middleware(middleware) {
|
147
222
|
return decorateMiddleware(middleware);
|
148
223
|
}
|
224
|
+
/**
|
225
|
+
* Adds type-safe custom errors.
|
226
|
+
* The provided errors are spared-merged with any existing errors.
|
227
|
+
*
|
228
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
229
|
+
*/
|
149
230
|
errors(errors) {
|
150
231
|
return new Builder({
|
151
232
|
...this["~orpc"],
|
@@ -159,18 +240,37 @@ class Builder {
|
|
159
240
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
160
241
|
});
|
161
242
|
}
|
243
|
+
/**
|
244
|
+
* Sets or updates the metadata.
|
245
|
+
* The provided metadata is spared-merged with any existing metadata.
|
246
|
+
*
|
247
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
248
|
+
*/
|
162
249
|
meta(meta) {
|
163
250
|
return new Builder({
|
164
251
|
...this["~orpc"],
|
165
252
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
166
253
|
});
|
167
254
|
}
|
255
|
+
/**
|
256
|
+
* Sets or updates the route definition.
|
257
|
+
* The provided route is spared-merged with any existing route.
|
258
|
+
* This option is typically relevant when integrating with OpenAPI.
|
259
|
+
*
|
260
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
261
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
262
|
+
*/
|
168
263
|
route(route) {
|
169
264
|
return new Builder({
|
170
265
|
...this["~orpc"],
|
171
266
|
route: mergeRoute(this["~orpc"].route, route)
|
172
267
|
});
|
173
268
|
}
|
269
|
+
/**
|
270
|
+
* Defines the input validation schema.
|
271
|
+
*
|
272
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
273
|
+
*/
|
174
274
|
input(schema) {
|
175
275
|
return new Builder({
|
176
276
|
...this["~orpc"],
|
@@ -178,6 +278,11 @@ class Builder {
|
|
178
278
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
179
279
|
});
|
180
280
|
}
|
281
|
+
/**
|
282
|
+
* Defines the output validation schema.
|
283
|
+
*
|
284
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
285
|
+
*/
|
181
286
|
output(schema) {
|
182
287
|
return new Builder({
|
183
288
|
...this["~orpc"],
|
@@ -185,27 +290,57 @@ class Builder {
|
|
185
290
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
186
291
|
});
|
187
292
|
}
|
293
|
+
/**
|
294
|
+
* Defines the handler of the procedure.
|
295
|
+
*
|
296
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
297
|
+
*/
|
188
298
|
handler(handler) {
|
189
299
|
return new DecoratedProcedure({
|
190
300
|
...this["~orpc"],
|
191
301
|
handler
|
192
302
|
});
|
193
303
|
}
|
304
|
+
/**
|
305
|
+
* Prefixes all procedures in the router.
|
306
|
+
* The provided prefix is post-appended to any existing router prefix.
|
307
|
+
*
|
308
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
309
|
+
*
|
310
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
311
|
+
*/
|
194
312
|
prefix(prefix) {
|
195
313
|
return new Builder({
|
196
314
|
...this["~orpc"],
|
197
315
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
198
316
|
});
|
199
317
|
}
|
318
|
+
/**
|
319
|
+
* Adds tags to all procedures in the router.
|
320
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
321
|
+
*
|
322
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
323
|
+
*/
|
200
324
|
tag(...tags) {
|
201
325
|
return new Builder({
|
202
326
|
...this["~orpc"],
|
203
327
|
tags: mergeTags(this["~orpc"].tags, tags)
|
204
328
|
});
|
205
329
|
}
|
330
|
+
/**
|
331
|
+
* Applies all of the previously defined options to the specified router.
|
332
|
+
*
|
333
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
334
|
+
*/
|
206
335
|
router(router) {
|
207
336
|
return enhanceRouter(router, this["~orpc"]);
|
208
337
|
}
|
338
|
+
/**
|
339
|
+
* Create a lazy router
|
340
|
+
* And applies all of the previously defined options to the specified router.
|
341
|
+
*
|
342
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
343
|
+
*/
|
209
344
|
lazy(loader) {
|
210
345
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
211
346
|
}
|
@@ -217,13 +352,10 @@ const os = new Builder({
|
|
217
352
|
errorMap: {},
|
218
353
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex"),
|
219
354
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex"),
|
220
|
-
middlewares: []
|
355
|
+
middlewares: [],
|
356
|
+
dedupeLeadingMiddlewares: true
|
221
357
|
});
|
222
358
|
|
223
|
-
function mergeContext(context, other) {
|
224
|
-
return { ...context, ...other };
|
225
|
-
}
|
226
|
-
|
227
359
|
function implementerInternal(contract, config, middlewares) {
|
228
360
|
if (isContractProcedure(contract)) {
|
229
361
|
const impl2 = new Builder({
|
@@ -231,7 +363,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
231
363
|
config,
|
232
364
|
middlewares,
|
233
365
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config?.initialInputValidationIndex) + middlewares.length,
|
234
|
-
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length
|
366
|
+
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length,
|
367
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
235
368
|
});
|
236
369
|
return impl2;
|
237
370
|
}
|
@@ -257,7 +390,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
257
390
|
middlewares,
|
258
391
|
errorMap: {},
|
259
392
|
prefix: void 0,
|
260
|
-
tags: void 0
|
393
|
+
tags: void 0,
|
394
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
261
395
|
});
|
262
396
|
return setHiddenRouterContract(adapted, contract);
|
263
397
|
};
|
@@ -267,7 +401,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
267
401
|
middlewares,
|
268
402
|
errorMap: {},
|
269
403
|
prefix: void 0,
|
270
|
-
tags: void 0
|
404
|
+
tags: void 0,
|
405
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
271
406
|
});
|
272
407
|
return setHiddenRouterContract(adapted, contract);
|
273
408
|
};
|
@@ -300,28 +435,25 @@ function implement(contract, config = {}) {
|
|
300
435
|
method = (config2) => implement(contract, config2);
|
301
436
|
}
|
302
437
|
const next = Reflect.get(target, key);
|
303
|
-
if (!next || typeof next !== "function" && typeof next !== "object") {
|
304
|
-
return method
|
438
|
+
if (!method || !next || typeof next !== "function" && typeof next !== "object") {
|
439
|
+
return method || next;
|
305
440
|
}
|
306
|
-
|
307
|
-
|
308
|
-
get(
|
309
|
-
|
310
|
-
|
311
|
-
});
|
312
|
-
}
|
313
|
-
return next;
|
441
|
+
return new Proxy(method, {
|
442
|
+
get(_, key2) {
|
443
|
+
return Reflect.get(next, key2);
|
444
|
+
}
|
445
|
+
});
|
314
446
|
}
|
315
447
|
});
|
316
448
|
return impl;
|
317
449
|
}
|
318
450
|
|
319
|
-
function createRouterClient(router, ...
|
451
|
+
function createRouterClient(router, ...rest) {
|
320
452
|
if (isProcedure(router)) {
|
321
|
-
const caller = createProcedureClient(router,
|
453
|
+
const caller = createProcedureClient(router, resolveMaybeOptionalOptions(rest));
|
322
454
|
return caller;
|
323
455
|
}
|
324
|
-
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router),
|
456
|
+
const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), resolveMaybeOptionalOptions(rest)) : {};
|
325
457
|
const recursive = new Proxy(procedureCaller, {
|
326
458
|
get(target, key) {
|
327
459
|
if (typeof key !== "string") {
|
@@ -332,12 +464,12 @@ function createRouterClient(router, ...[options]) {
|
|
332
464
|
return Reflect.get(target, key);
|
333
465
|
}
|
334
466
|
return createRouterClient(next, {
|
335
|
-
...
|
336
|
-
path: [...
|
467
|
+
...rest[0],
|
468
|
+
path: [...rest[0]?.path ?? [], key]
|
337
469
|
});
|
338
470
|
}
|
339
471
|
});
|
340
472
|
return recursive;
|
341
473
|
}
|
342
474
|
|
343
|
-
export { Builder, DecoratedProcedure, Procedure, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy,
|
475
|
+
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 {
|
2
|
-
|
3
|
-
import {
|
4
|
-
import {
|
5
|
-
import '
|
6
|
-
import '@orpc/
|
7
|
-
import '@orpc/client';
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
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.Dq8xr7PQ.mjs';
|
5
|
+
import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DD2C4ujN.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<Promisable<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<Promisable<number>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
28
|
+
/**
|
29
|
+
* success batch response headers.
|
30
|
+
*
|
31
|
+
* @default {}
|
32
|
+
*/
|
33
|
+
headers?: Value<Promisable<StandardHeaders>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
34
|
+
}
|
35
|
+
/**
|
36
|
+
* The Batch Requests 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-requests Batch Requests 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<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
53
|
+
timingOrigin?: Value<Promisable<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<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
92
|
+
/**
|
93
|
+
* The value of the header to check.
|
94
|
+
*
|
95
|
+
* @default 'orpc'
|
96
|
+
*
|
97
|
+
*/
|
98
|
+
headerValue?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
99
|
+
/**
|
100
|
+
* Exclude a procedure from the plugin.
|
101
|
+
*
|
102
|
+
* @default false
|
103
|
+
*
|
104
|
+
*/
|
105
|
+
exclude?: Value<Promisable<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 };
|