@orpc/server 0.0.0-next.d452413 → 0.0.0-next.d4f9056
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 +34 -23
- package/dist/adapters/aws-lambda/index.d.mts +46 -0
- package/dist/adapters/aws-lambda/index.d.ts +46 -0
- package/dist/adapters/aws-lambda/index.mjs +42 -0
- package/dist/adapters/bun-ws/index.d.mts +36 -0
- package/dist/adapters/bun-ws/index.d.ts +36 -0
- package/dist/adapters/bun-ws/index.mjs +47 -0
- package/dist/adapters/crossws/index.d.mts +33 -0
- package/dist/adapters/crossws/index.d.ts +33 -0
- package/dist/adapters/crossws/index.mjs +45 -0
- package/dist/adapters/fetch/index.d.mts +108 -10
- package/dist/adapters/fetch/index.d.ts +108 -10
- package/dist/adapters/fetch/index.mjs +179 -8
- package/dist/adapters/message-port/index.d.mts +31 -0
- package/dist/adapters/message-port/index.d.ts +31 -0
- package/dist/adapters/message-port/index.mjs +39 -0
- package/dist/adapters/node/index.d.mts +86 -21
- package/dist/adapters/node/index.d.ts +86 -21
- package/dist/adapters/node/index.mjs +144 -23
- package/dist/adapters/standard/index.d.mts +11 -15
- package/dist/adapters/standard/index.d.ts +11 -15
- package/dist/adapters/standard/index.mjs +5 -3
- package/dist/adapters/standard-peer/index.d.mts +18 -0
- package/dist/adapters/standard-peer/index.d.ts +18 -0
- package/dist/adapters/standard-peer/index.mjs +7 -0
- package/dist/adapters/websocket/index.d.mts +56 -0
- package/dist/adapters/websocket/index.d.ts +56 -0
- package/dist/adapters/websocket/index.mjs +67 -0
- package/dist/adapters/ws/index.d.mts +31 -0
- package/dist/adapters/ws/index.d.ts +31 -0
- package/dist/adapters/ws/index.mjs +37 -0
- package/dist/helpers/index.d.mts +149 -0
- package/dist/helpers/index.d.ts +149 -0
- package/dist/helpers/index.mjs +198 -0
- package/dist/hibernation/index.d.mts +44 -0
- package/dist/hibernation/index.d.ts +44 -0
- package/dist/hibernation/index.mjs +65 -0
- package/dist/index.d.mts +622 -88
- package/dist/index.d.ts +622 -88
- package/dist/index.mjs +185 -36
- package/dist/plugins/index.d.mts +157 -16
- package/dist/plugins/index.d.ts +157 -16
- package/dist/plugins/index.mjs +200 -16
- package/dist/shared/{server.Zu6nd6jA.d.mts → server.B4BGqy3Y.d.mts} +68 -17
- package/dist/shared/{server.Zu6nd6jA.d.ts → server.B4BGqy3Y.d.ts} +68 -17
- package/dist/shared/server.Bxx6tqNe.mjs +219 -0
- package/dist/shared/server.COL12UTb.d.ts +32 -0
- package/dist/shared/server.CVKCo60T.d.mts +12 -0
- package/dist/shared/server.Cb6yD7DZ.d.ts +42 -0
- package/dist/shared/server.Ck-gOLzq.d.mts +32 -0
- package/dist/shared/server.DBCUJijK.d.mts +74 -0
- package/dist/shared/server.DNtJ-p60.d.ts +12 -0
- package/dist/shared/server.DPIFWpxG.d.ts +74 -0
- package/dist/shared/server.DZ5BIITo.mjs +9 -0
- package/dist/shared/{server.CMrS28Go.mjs → server.Ds4HPpvH.mjs} +148 -85
- package/dist/shared/server.DzV1hr3z.d.mts +42 -0
- package/dist/shared/server.TEVCLCFC.mjs +39 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/package.json +72 -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.CSZRzcSW.mjs +0 -158
- package/dist/shared/server.Cq3B6PoL.mjs +0 -28
- package/dist/shared/server.Ctc1Ekur.d.mts +0 -75
- package/dist/shared/server.DyteP6Y8.d.ts +0 -75
- package/dist/shared/server.Q6ZmnTgO.mjs +0 -12
package/dist/index.mjs
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
|
-
import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter } from '@orpc/contract';
|
|
2
|
-
export { ValidationError, eventIterator, type } from '@orpc/contract';
|
|
3
|
-
import { P as Procedure,
|
|
4
|
-
export { L as LAZY_SYMBOL,
|
|
1
|
+
import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter, fallbackContractConfig } from '@orpc/contract';
|
|
2
|
+
export { ValidationError, eventIterator, type, validateORPCError } from '@orpc/contract';
|
|
3
|
+
import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, u as unlazy, g as getRouter, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure } from './shared/server.Ds4HPpvH.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, v as resolveContractProcedures, t as traverseContractProcedures, w as unlazyRouter } from './shared/server.Ds4HPpvH.mjs';
|
|
5
|
+
import { toORPCError } from '@orpc/client';
|
|
5
6
|
export { ORPCError, isDefinedError, safe } from '@orpc/client';
|
|
6
|
-
|
|
7
|
+
import { isObject, resolveMaybeOptionalOptions } from '@orpc/shared';
|
|
8
|
+
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } 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) {
|
|
@@ -18,7 +21,7 @@ function fallbackConfig(key, value) {
|
|
|
18
21
|
}
|
|
19
22
|
|
|
20
23
|
function decorateMiddleware(middleware) {
|
|
21
|
-
const decorated = (...args) => middleware(...args);
|
|
24
|
+
const decorated = ((...args) => middleware(...args));
|
|
22
25
|
decorated.mapInput = (mapInput) => {
|
|
23
26
|
const mapped = decorateMiddleware(
|
|
24
27
|
(options, input, ...rest) => middleware(options, mapInput(input), ...rest)
|
|
@@ -43,19 +46,56 @@ 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
|
+
if (error instanceof Response && "options" in error && isObject(error.options) || isObject(error) && error.isNotFound === true) {
|
|
58
|
+
throw error;
|
|
59
|
+
}
|
|
60
|
+
return [toORPCError(error).toJSON(), void 0];
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
return action;
|
|
64
|
+
}
|
|
65
|
+
|
|
46
66
|
class DecoratedProcedure extends Procedure {
|
|
67
|
+
/**
|
|
68
|
+
* Adds type-safe custom errors.
|
|
69
|
+
* The provided errors are spared-merged with any existing errors.
|
|
70
|
+
*
|
|
71
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
72
|
+
*/
|
|
47
73
|
errors(errors) {
|
|
48
74
|
return new DecoratedProcedure({
|
|
49
75
|
...this["~orpc"],
|
|
50
76
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
51
77
|
});
|
|
52
78
|
}
|
|
79
|
+
/**
|
|
80
|
+
* Sets or updates the metadata.
|
|
81
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
82
|
+
*
|
|
83
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
84
|
+
*/
|
|
53
85
|
meta(meta) {
|
|
54
86
|
return new DecoratedProcedure({
|
|
55
87
|
...this["~orpc"],
|
|
56
88
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
57
89
|
});
|
|
58
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Sets or updates the route definition.
|
|
93
|
+
* The provided route is spared-merged with any existing route.
|
|
94
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
95
|
+
*
|
|
96
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
97
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
98
|
+
*/
|
|
59
99
|
route(route) {
|
|
60
100
|
return new DecoratedProcedure({
|
|
61
101
|
...this["~orpc"],
|
|
@@ -71,9 +111,12 @@ class DecoratedProcedure extends Procedure {
|
|
|
71
111
|
}
|
|
72
112
|
/**
|
|
73
113
|
* Make this procedure callable (works like a function while still being a procedure).
|
|
114
|
+
*
|
|
115
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
74
116
|
*/
|
|
75
117
|
callable(...rest) {
|
|
76
|
-
|
|
118
|
+
const client = createProcedureClient(this, ...rest);
|
|
119
|
+
return new Proxy(client, {
|
|
77
120
|
get: (target, key) => {
|
|
78
121
|
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
|
79
122
|
},
|
|
@@ -83,20 +126,36 @@ class DecoratedProcedure extends Procedure {
|
|
|
83
126
|
});
|
|
84
127
|
}
|
|
85
128
|
/**
|
|
86
|
-
* Make this procedure compatible with server action
|
|
129
|
+
* Make this procedure compatible with server action.
|
|
130
|
+
*
|
|
131
|
+
* @see {@link https://orpc.unnoq.com/docs/server-action Server Action Docs}
|
|
87
132
|
*/
|
|
88
133
|
actionable(...rest) {
|
|
89
|
-
|
|
134
|
+
const action = createActionableClient(createProcedureClient(this, ...rest));
|
|
135
|
+
return new Proxy(action, {
|
|
136
|
+
get: (target, key) => {
|
|
137
|
+
return Reflect.has(this, key) ? Reflect.get(this, key) : Reflect.get(target, key);
|
|
138
|
+
},
|
|
139
|
+
has: (target, key) => {
|
|
140
|
+
return Reflect.has(this, key) || Reflect.has(target, key);
|
|
141
|
+
}
|
|
142
|
+
});
|
|
90
143
|
}
|
|
91
144
|
}
|
|
92
145
|
|
|
93
146
|
class Builder {
|
|
147
|
+
/**
|
|
148
|
+
* This property holds the defined options.
|
|
149
|
+
*/
|
|
94
150
|
"~orpc";
|
|
95
151
|
constructor(def) {
|
|
96
152
|
this["~orpc"] = def;
|
|
97
153
|
}
|
|
98
154
|
/**
|
|
99
|
-
*
|
|
155
|
+
* Sets or overrides the config.
|
|
156
|
+
*
|
|
157
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side#middlewares-order Middlewares Order Docs}
|
|
158
|
+
* @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
|
|
100
159
|
*/
|
|
101
160
|
$config(config) {
|
|
102
161
|
const inputValidationCount = this["~orpc"].inputValidationIndex - fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex);
|
|
@@ -104,12 +163,15 @@ class Builder {
|
|
|
104
163
|
return new Builder({
|
|
105
164
|
...this["~orpc"],
|
|
106
165
|
config,
|
|
166
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares),
|
|
107
167
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config.initialInputValidationIndex) + inputValidationCount,
|
|
108
168
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config.initialOutputValidationIndex) + outputValidationCount
|
|
109
169
|
});
|
|
110
170
|
}
|
|
111
171
|
/**
|
|
112
|
-
*
|
|
172
|
+
* Set or override the initial context.
|
|
173
|
+
*
|
|
174
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
113
175
|
*/
|
|
114
176
|
$context() {
|
|
115
177
|
return new Builder({
|
|
@@ -120,7 +182,9 @@ class Builder {
|
|
|
120
182
|
});
|
|
121
183
|
}
|
|
122
184
|
/**
|
|
123
|
-
*
|
|
185
|
+
* Sets or overrides the initial meta.
|
|
186
|
+
*
|
|
187
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
124
188
|
*/
|
|
125
189
|
$meta(initialMeta) {
|
|
126
190
|
return new Builder({
|
|
@@ -129,7 +193,11 @@ class Builder {
|
|
|
129
193
|
});
|
|
130
194
|
}
|
|
131
195
|
/**
|
|
132
|
-
*
|
|
196
|
+
* Sets or overrides the initial route.
|
|
197
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
198
|
+
*
|
|
199
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
200
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
133
201
|
*/
|
|
134
202
|
$route(initialRoute) {
|
|
135
203
|
return new Builder({
|
|
@@ -137,15 +205,31 @@ class Builder {
|
|
|
137
205
|
route: initialRoute
|
|
138
206
|
});
|
|
139
207
|
}
|
|
208
|
+
/**
|
|
209
|
+
* Sets or overrides the initial input schema.
|
|
210
|
+
*
|
|
211
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
|
|
212
|
+
*/
|
|
140
213
|
$input(initialInputSchema) {
|
|
141
214
|
return new Builder({
|
|
142
215
|
...this["~orpc"],
|
|
143
216
|
inputSchema: initialInputSchema
|
|
144
217
|
});
|
|
145
218
|
}
|
|
219
|
+
/**
|
|
220
|
+
* Creates a middleware.
|
|
221
|
+
*
|
|
222
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
223
|
+
*/
|
|
146
224
|
middleware(middleware) {
|
|
147
225
|
return decorateMiddleware(middleware);
|
|
148
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* Adds type-safe custom errors.
|
|
229
|
+
* The provided errors are spared-merged with any existing errors.
|
|
230
|
+
*
|
|
231
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
232
|
+
*/
|
|
149
233
|
errors(errors) {
|
|
150
234
|
return new Builder({
|
|
151
235
|
...this["~orpc"],
|
|
@@ -159,18 +243,37 @@ class Builder {
|
|
|
159
243
|
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
|
160
244
|
});
|
|
161
245
|
}
|
|
246
|
+
/**
|
|
247
|
+
* Sets or updates the metadata.
|
|
248
|
+
* The provided metadata is spared-merged with any existing metadata.
|
|
249
|
+
*
|
|
250
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
251
|
+
*/
|
|
162
252
|
meta(meta) {
|
|
163
253
|
return new Builder({
|
|
164
254
|
...this["~orpc"],
|
|
165
255
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
166
256
|
});
|
|
167
257
|
}
|
|
258
|
+
/**
|
|
259
|
+
* Sets or updates the route definition.
|
|
260
|
+
* The provided route is spared-merged with any existing route.
|
|
261
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
262
|
+
*
|
|
263
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
264
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
265
|
+
*/
|
|
168
266
|
route(route) {
|
|
169
267
|
return new Builder({
|
|
170
268
|
...this["~orpc"],
|
|
171
269
|
route: mergeRoute(this["~orpc"].route, route)
|
|
172
270
|
});
|
|
173
271
|
}
|
|
272
|
+
/**
|
|
273
|
+
* Defines the input validation schema.
|
|
274
|
+
*
|
|
275
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
276
|
+
*/
|
|
174
277
|
input(schema) {
|
|
175
278
|
return new Builder({
|
|
176
279
|
...this["~orpc"],
|
|
@@ -178,6 +281,11 @@ class Builder {
|
|
|
178
281
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", this["~orpc"].config.initialInputValidationIndex) + this["~orpc"].middlewares.length
|
|
179
282
|
});
|
|
180
283
|
}
|
|
284
|
+
/**
|
|
285
|
+
* Defines the output validation schema.
|
|
286
|
+
*
|
|
287
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
288
|
+
*/
|
|
181
289
|
output(schema) {
|
|
182
290
|
return new Builder({
|
|
183
291
|
...this["~orpc"],
|
|
@@ -185,27 +293,57 @@ class Builder {
|
|
|
185
293
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", this["~orpc"].config.initialOutputValidationIndex) + this["~orpc"].middlewares.length
|
|
186
294
|
});
|
|
187
295
|
}
|
|
296
|
+
/**
|
|
297
|
+
* Defines the handler of the procedure.
|
|
298
|
+
*
|
|
299
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
300
|
+
*/
|
|
188
301
|
handler(handler) {
|
|
189
302
|
return new DecoratedProcedure({
|
|
190
303
|
...this["~orpc"],
|
|
191
304
|
handler
|
|
192
305
|
});
|
|
193
306
|
}
|
|
307
|
+
/**
|
|
308
|
+
* Prefixes all procedures in the router.
|
|
309
|
+
* The provided prefix is post-appended to any existing router prefix.
|
|
310
|
+
*
|
|
311
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
312
|
+
*
|
|
313
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
314
|
+
*/
|
|
194
315
|
prefix(prefix) {
|
|
195
316
|
return new Builder({
|
|
196
317
|
...this["~orpc"],
|
|
197
318
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
|
198
319
|
});
|
|
199
320
|
}
|
|
321
|
+
/**
|
|
322
|
+
* Adds tags to all procedures in the router.
|
|
323
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
324
|
+
*
|
|
325
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
326
|
+
*/
|
|
200
327
|
tag(...tags) {
|
|
201
328
|
return new Builder({
|
|
202
329
|
...this["~orpc"],
|
|
203
330
|
tags: mergeTags(this["~orpc"].tags, tags)
|
|
204
331
|
});
|
|
205
332
|
}
|
|
333
|
+
/**
|
|
334
|
+
* Applies all of the previously defined options to the specified router.
|
|
335
|
+
*
|
|
336
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
337
|
+
*/
|
|
206
338
|
router(router) {
|
|
207
339
|
return enhanceRouter(router, this["~orpc"]);
|
|
208
340
|
}
|
|
341
|
+
/**
|
|
342
|
+
* Create a lazy router
|
|
343
|
+
* And applies all of the previously defined options to the specified router.
|
|
344
|
+
*
|
|
345
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
346
|
+
*/
|
|
209
347
|
lazy(loader) {
|
|
210
348
|
return enhanceRouter(lazy(loader), this["~orpc"]);
|
|
211
349
|
}
|
|
@@ -217,13 +355,10 @@ const os = new Builder({
|
|
|
217
355
|
errorMap: {},
|
|
218
356
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex"),
|
|
219
357
|
outputValidationIndex: fallbackConfig("initialOutputValidationIndex"),
|
|
220
|
-
middlewares: []
|
|
358
|
+
middlewares: [],
|
|
359
|
+
dedupeLeadingMiddlewares: true
|
|
221
360
|
});
|
|
222
361
|
|
|
223
|
-
function mergeCurrentContext(context, other) {
|
|
224
|
-
return { ...context, ...other };
|
|
225
|
-
}
|
|
226
|
-
|
|
227
362
|
function implementerInternal(contract, config, middlewares) {
|
|
228
363
|
if (isContractProcedure(contract)) {
|
|
229
364
|
const impl2 = new Builder({
|
|
@@ -231,7 +366,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
|
231
366
|
config,
|
|
232
367
|
middlewares,
|
|
233
368
|
inputValidationIndex: fallbackConfig("initialInputValidationIndex", config?.initialInputValidationIndex) + middlewares.length,
|
|
234
|
-
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length
|
|
369
|
+
outputValidationIndex: fallbackConfig("initialOutputValidationIndex", config?.initialOutputValidationIndex) + middlewares.length,
|
|
370
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
|
235
371
|
});
|
|
236
372
|
return impl2;
|
|
237
373
|
}
|
|
@@ -257,7 +393,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
|
257
393
|
middlewares,
|
|
258
394
|
errorMap: {},
|
|
259
395
|
prefix: void 0,
|
|
260
|
-
tags: void 0
|
|
396
|
+
tags: void 0,
|
|
397
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
|
261
398
|
});
|
|
262
399
|
return setHiddenRouterContract(adapted, contract);
|
|
263
400
|
};
|
|
@@ -267,7 +404,8 @@ function implementerInternal(contract, config, middlewares) {
|
|
|
267
404
|
middlewares,
|
|
268
405
|
errorMap: {},
|
|
269
406
|
prefix: void 0,
|
|
270
|
-
tags: void 0
|
|
407
|
+
tags: void 0,
|
|
408
|
+
dedupeLeadingMiddlewares: fallbackConfig("dedupeLeadingMiddlewares", config.dedupeLeadingMiddlewares)
|
|
271
409
|
});
|
|
272
410
|
return setHiddenRouterContract(adapted, contract);
|
|
273
411
|
};
|
|
@@ -300,23 +438,34 @@ function implement(contract, config = {}) {
|
|
|
300
438
|
method = (config2) => implement(contract, config2);
|
|
301
439
|
}
|
|
302
440
|
const next = Reflect.get(target, key);
|
|
303
|
-
if (!next || typeof next !== "function" && typeof next !== "object") {
|
|
304
|
-
return method
|
|
441
|
+
if (!method || !next || typeof next !== "function" && typeof next !== "object") {
|
|
442
|
+
return method || next;
|
|
305
443
|
}
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
get(
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
});
|
|
312
|
-
}
|
|
313
|
-
return next;
|
|
444
|
+
return new Proxy(method, {
|
|
445
|
+
get(_, key2) {
|
|
446
|
+
return Reflect.get(next, key2);
|
|
447
|
+
}
|
|
448
|
+
});
|
|
314
449
|
}
|
|
315
450
|
});
|
|
316
451
|
return impl;
|
|
317
452
|
}
|
|
318
453
|
|
|
319
|
-
function
|
|
454
|
+
function inferRPCMethodFromRouter(router) {
|
|
455
|
+
return async (_, path) => {
|
|
456
|
+
const { default: procedure } = await unlazy(getRouter(router, path));
|
|
457
|
+
if (!isProcedure(procedure)) {
|
|
458
|
+
throw new Error(
|
|
459
|
+
`[inferRPCMethodFromRouter] No valid procedure found at path "${path.join(".")}". This may happen when the router is not properly configured.`
|
|
460
|
+
);
|
|
461
|
+
}
|
|
462
|
+
const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
|
|
463
|
+
return method === "HEAD" ? "GET" : method;
|
|
464
|
+
};
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
function createRouterClient(router, ...rest) {
|
|
468
|
+
const options = resolveMaybeOptionalOptions(rest);
|
|
320
469
|
if (isProcedure(router)) {
|
|
321
470
|
const caller = createProcedureClient(router, options);
|
|
322
471
|
return caller;
|
|
@@ -332,12 +481,12 @@ function createRouterClient(router, ...[options]) {
|
|
|
332
481
|
return Reflect.get(target, key);
|
|
333
482
|
}
|
|
334
483
|
return createRouterClient(next, {
|
|
335
|
-
...
|
|
336
|
-
path: [...
|
|
484
|
+
...rest[0],
|
|
485
|
+
path: [...rest[0]?.path ?? [], key]
|
|
337
486
|
});
|
|
338
487
|
}
|
|
339
488
|
});
|
|
340
489
|
return recursive;
|
|
341
490
|
}
|
|
342
491
|
|
|
343
|
-
export { Builder, DecoratedProcedure, Procedure, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy,
|
|
492
|
+
export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, inferRPCMethodFromRouter, isLazy, isProcedure, lazy, os, setHiddenRouterContract, unlazy };
|
package/dist/plugins/index.d.mts
CHANGED
|
@@ -1,31 +1,172 @@
|
|
|
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 { d as StandardHandlerInterceptorOptions, g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.DBCUJijK.mjs';
|
|
5
|
+
import { C as Context, d as ProcedureClientInterceptorOptions } from '../shared/server.B4BGqy3Y.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;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
interface RequestHeadersPluginContext {
|
|
73
|
+
reqHeaders?: Headers;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* The Request Headers Plugin injects a `reqHeaders` instance into the context,
|
|
77
|
+
* allowing access to request headers in oRPC.
|
|
78
|
+
*
|
|
79
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/request-headers Request Headers Plugin Docs}
|
|
80
|
+
*/
|
|
81
|
+
declare class RequestHeadersPlugin<T extends RequestHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
|
82
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
22
83
|
}
|
|
23
84
|
|
|
24
85
|
interface ResponseHeadersPluginContext {
|
|
25
86
|
resHeaders?: Headers;
|
|
26
87
|
}
|
|
27
|
-
|
|
28
|
-
|
|
88
|
+
/**
|
|
89
|
+
* The Response Headers Plugin allows you to set response headers in oRPC.
|
|
90
|
+
* It injects a resHeaders instance into the context, enabling you to modify response headers easily.
|
|
91
|
+
*
|
|
92
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
|
|
93
|
+
*/
|
|
94
|
+
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
|
95
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
|
|
99
|
+
/**
|
|
100
|
+
* The name of the header to check.
|
|
101
|
+
*
|
|
102
|
+
* @default 'x-csrf-token'
|
|
103
|
+
*/
|
|
104
|
+
headerName?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
|
105
|
+
/**
|
|
106
|
+
* The value of the header to check.
|
|
107
|
+
*
|
|
108
|
+
* @default 'orpc'
|
|
109
|
+
*
|
|
110
|
+
*/
|
|
111
|
+
headerValue?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
|
112
|
+
/**
|
|
113
|
+
* Exclude a procedure from the plugin.
|
|
114
|
+
*
|
|
115
|
+
* @default false
|
|
116
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
|
|
119
|
+
/**
|
|
120
|
+
* The error thrown when the CSRF token is invalid.
|
|
121
|
+
*
|
|
122
|
+
* @default new ORPCError('CSRF_TOKEN_MISMATCH', {
|
|
123
|
+
* status: 403,
|
|
124
|
+
* message: 'Invalid CSRF token',
|
|
125
|
+
* })
|
|
126
|
+
*/
|
|
127
|
+
error?: InstanceType<typeof ORPCError>;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
|
131
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
|
132
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
|
133
|
+
*
|
|
134
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
|
135
|
+
*/
|
|
136
|
+
declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
137
|
+
private readonly headerName;
|
|
138
|
+
private readonly headerValue;
|
|
139
|
+
private readonly exclude;
|
|
140
|
+
private readonly error;
|
|
141
|
+
constructor(options?: SimpleCsrfProtectionHandlerPluginOptions<T>);
|
|
142
|
+
order: number;
|
|
143
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
interface StrictGetMethodPluginOptions {
|
|
147
|
+
/**
|
|
148
|
+
* The error thrown when a GET request is made to a procedure that doesn't allow GET.
|
|
149
|
+
*
|
|
150
|
+
* @default new ORPCError('METHOD_NOT_SUPPORTED')
|
|
151
|
+
*/
|
|
152
|
+
error?: InstanceType<typeof ORPCError$1>;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* This plugin enhances security by ensuring only procedures explicitly marked to accept GET requests
|
|
156
|
+
* can be called using the HTTP GET method for RPC Protocol. This helps prevent certain types of
|
|
157
|
+
* Cross-Site Request Forgery (CSRF) attacks.
|
|
158
|
+
*
|
|
159
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/strict-get-method Strict Get Method Plugin Docs}
|
|
160
|
+
*/
|
|
161
|
+
declare class StrictGetMethodPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
162
|
+
private readonly error;
|
|
163
|
+
/**
|
|
164
|
+
* make sure execute before batch plugin to get real method
|
|
165
|
+
*/
|
|
166
|
+
order: number;
|
|
167
|
+
constructor(options?: StrictGetMethodPluginOptions);
|
|
168
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
29
169
|
}
|
|
30
170
|
|
|
31
|
-
export {
|
|
171
|
+
export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
|
172
|
+
export type { BatchHandlerOptions, CORSOptions, RequestHeadersPluginContext, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|