@orpc/server 2.0.0-beta.3 → 2.0.0-beta.31
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 +71 -101
- package/dist/adapters/aws-lambda/index.d.mts +93 -0
- package/dist/adapters/aws-lambda/index.d.ts +93 -0
- package/dist/adapters/aws-lambda/index.mjs +66 -0
- package/dist/adapters/crossws/index.d.mts +17 -8
- package/dist/adapters/crossws/index.d.ts +17 -8
- package/dist/adapters/crossws/index.mjs +10 -7
- package/dist/adapters/fastify/index.d.mts +85 -0
- package/dist/adapters/fastify/index.d.ts +85 -0
- package/dist/adapters/fastify/index.mjs +66 -0
- package/dist/adapters/fetch/index.d.mts +16 -67
- package/dist/adapters/fetch/index.d.ts +16 -67
- package/dist/adapters/fetch/index.mjs +8 -144
- package/dist/adapters/message-port/index.d.mts +19 -16
- package/dist/adapters/message-port/index.d.ts +19 -16
- package/dist/adapters/message-port/index.mjs +28 -32
- package/dist/adapters/node/index.d.mts +15 -49
- package/dist/adapters/node/index.d.ts +15 -49
- package/dist/adapters/node/index.mjs +9 -120
- package/dist/adapters/standard/index.d.mts +6 -6
- package/dist/adapters/standard/index.d.ts +6 -6
- package/dist/adapters/standard/index.mjs +3 -3
- package/dist/adapters/standard-peer/index.d.mts +2 -2
- package/dist/adapters/standard-peer/index.d.ts +2 -2
- package/dist/adapters/websocket/index.d.mts +42 -26
- package/dist/adapters/websocket/index.d.ts +42 -26
- package/dist/adapters/websocket/index.mjs +33 -25
- package/dist/extensions/callable.d.mts +2 -2
- package/dist/extensions/callable.d.ts +2 -2
- package/dist/extensions/callable.mjs +2 -2
- package/dist/helpers/index.d.mts +23 -6
- package/dist/helpers/index.d.ts +23 -6
- package/dist/helpers/index.mjs +13 -5
- package/dist/index.d.mts +311 -16
- package/dist/index.d.ts +311 -16
- package/dist/index.mjs +126 -34
- package/dist/plugins/index.d.mts +241 -32
- package/dist/plugins/index.d.ts +241 -32
- package/dist/plugins/index.mjs +479 -15
- package/dist/shared/server.BhHrioCw.d.ts +34 -0
- package/dist/shared/{server.T9F3bzZx.d.ts → server.C2n16pp0.d.ts} +34 -9
- package/dist/shared/server.Cd4Z1hpV.mjs +69 -0
- package/dist/shared/{server.CrlKQucM.mjs → server.CkButhNT.mjs} +21 -38
- package/dist/shared/{server.B_U9y00a.d.mts → server.CkNnZ5F-.d.mts} +34 -9
- package/dist/shared/{server.BL22TloH.d.mts → server.CwrYlF72.d.mts} +31 -41
- package/dist/shared/{server.BL22TloH.d.ts → server.CwrYlF72.d.ts} +31 -41
- package/dist/shared/server.D0Ipbmdv.d.mts +34 -0
- package/dist/shared/{server.BwHnWUuN.mjs → server.Dh77P3ii.mjs} +17 -10
- package/dist/shared/{server.Pa0F03f_.d.ts → server.Dm0os-OP.d.mts} +24 -12
- package/dist/shared/{server.GDpX6Df8.mjs → server.DpUGXBi2.mjs} +84 -51
- package/dist/shared/{server.EOHJ3NJr.d.ts → server.DrN1Pj1-.d.ts} +3 -3
- package/dist/shared/{server.BsNNjG5J.d.mts → server.DtfwuV6U.d.ts} +24 -12
- package/dist/shared/{server.BB_Ik9Ph.d.mts → server.JbCIPL4P.d.mts} +3 -3
- package/dist/shared/{server.CjOb6ItT.mjs → server.eCTV8Vpp.mjs} +1 -1
- package/package.json +46 -12
- package/dist/shared/server.D_QauotT.mjs +0 -30
package/dist/index.mjs
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { mergeErrorMap, resolveMetaPlugins, getHiddenMetaPlugins, ProcedureContract } from '@orpc/contract';
|
|
2
|
-
export { ValidationError, defineMeta, eventIterator, reconcileORPCError, type } from '@orpc/contract';
|
|
3
|
-
import { toArray, bindMethods,
|
|
4
|
-
export { AsyncIteratorClass, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess,
|
|
5
|
-
import { L as Lazy, P as Procedure, c as createProcedureClient } from './shared/server.
|
|
6
|
-
export {
|
|
7
|
-
import { D as DecoratedProcedure } from './shared/server.
|
|
8
|
-
import { b as augmentRouter, d as augmentImplementedRouter, e as withHiddenRouterContract, f as createGuardedProcedureLazy, g as getRouter } from './shared/server.
|
|
9
|
-
export { a as DEFAULT_ERROR_STATUS, D as DEFAULT_SUCCESS_STATUS, h as call, c as createContractProcedure, i as getHiddenRouterContract, u as unlazyRouter, j as walkProcedureContractsAsync, w as walkProcedureContractsSync } from './shared/server.
|
|
2
|
+
export { ValidationError, asyncIteratorObject, defineMeta, error, eventIterator, reconcileORPCError, type } from '@orpc/contract';
|
|
3
|
+
import { toArray, bindMethods, isTypescriptObject, resolveMaybeOptionalOptions } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
|
|
5
|
+
import { L as Lazy, P as Procedure, c as createProcedureClient } from './shared/server.CkButhNT.mjs';
|
|
6
|
+
export { u as unlazy } from './shared/server.CkButhNT.mjs';
|
|
7
|
+
import { D as DecoratedProcedure } from './shared/server.eCTV8Vpp.mjs';
|
|
8
|
+
import { b as augmentRouter, d as augmentImplementedRouter, e as withHiddenRouterContract, f as createGuardedProcedureLazy, g as getRouter } from './shared/server.Dh77P3ii.mjs';
|
|
9
|
+
export { a as DEFAULT_ERROR_STATUS, D as DEFAULT_SUCCESS_STATUS, h as call, c as createContractProcedure, i as getHiddenRouterContract, u as unlazyRouter, j as walkProcedureContractsAsync, w as walkProcedureContractsSync } from './shared/server.Dh77P3ii.mjs';
|
|
10
10
|
import { RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
|
|
11
11
|
export { COMMON_ERROR_STATUS_MAP, ORPCError, RPCJsonSerializer, RPCSerializer, cloneORPCError, isDefinedError, isInferableError, safe, toORPCError } from '@orpc/client';
|
|
12
12
|
export { ErrorEvent, getEventMeta, unwrapEvent, withEventMeta } from '@standardserver/core';
|
|
@@ -86,9 +86,19 @@ function decorateMiddleware(middleware) {
|
|
|
86
86
|
|
|
87
87
|
class Builder {
|
|
88
88
|
"~orpc";
|
|
89
|
+
/**
|
|
90
|
+
* Private constructor to prevent direct instantiation.
|
|
91
|
+
* Use the static `create` method to initialize a new instance with a safe initial definition.
|
|
92
|
+
*/
|
|
89
93
|
constructor(definition) {
|
|
90
94
|
this["~orpc"] = definition;
|
|
91
95
|
}
|
|
96
|
+
/**
|
|
97
|
+
* Creates a fresh builder with an empty definition.
|
|
98
|
+
* Prefer the exported `os` instance over calling this directly.
|
|
99
|
+
*
|
|
100
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
101
|
+
*/
|
|
92
102
|
static create() {
|
|
93
103
|
return new Builder({
|
|
94
104
|
errorMap: {},
|
|
@@ -96,9 +106,32 @@ class Builder {
|
|
|
96
106
|
orderedMiddlewares: []
|
|
97
107
|
});
|
|
98
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Declares the initial context type that must be provided when executing
|
|
111
|
+
* procedures built from this builder.
|
|
112
|
+
*
|
|
113
|
+
* @see {@link https://orpc.dev/docs/context#initial-context | Context - Initial Context}
|
|
114
|
+
*/
|
|
99
115
|
$context() {
|
|
100
116
|
return this;
|
|
101
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* Overrides the procedure configuration, such as disabling runtime
|
|
120
|
+
* input/output validation.
|
|
121
|
+
*
|
|
122
|
+
* @see {@link https://orpc.dev/docs/recipes/validation-customization | Validation Customization}
|
|
123
|
+
*/
|
|
124
|
+
$config(config) {
|
|
125
|
+
return new Builder({
|
|
126
|
+
...this["~orpc"],
|
|
127
|
+
...config
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Applies metadata plugins to procedures built from this builder.
|
|
132
|
+
*
|
|
133
|
+
* @see {@link https://orpc.dev/docs/metadata | Metadata}
|
|
134
|
+
*/
|
|
102
135
|
meta(...plugins) {
|
|
103
136
|
const [meta, metaPlugins] = resolveMetaPlugins(
|
|
104
137
|
this["~orpc"].meta,
|
|
@@ -111,6 +144,12 @@ class Builder {
|
|
|
111
144
|
metaPlugins
|
|
112
145
|
});
|
|
113
146
|
}
|
|
147
|
+
/**
|
|
148
|
+
* Defines typesafe errors that procedures built from this builder can throw
|
|
149
|
+
* via the `errors` utility in handlers and middleware.
|
|
150
|
+
*
|
|
151
|
+
* @see {@link https://orpc.dev/docs/error-handling#typesafe-errors | Error Handling - Typesafe Errors}
|
|
152
|
+
*/
|
|
114
153
|
errors(errors) {
|
|
115
154
|
let builder = new Builder({
|
|
116
155
|
...this["~orpc"],
|
|
@@ -122,6 +161,12 @@ class Builder {
|
|
|
122
161
|
}
|
|
123
162
|
return builder;
|
|
124
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Applies a middleware that runs before the handler of every procedure
|
|
166
|
+
* built from this builder.
|
|
167
|
+
*
|
|
168
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
169
|
+
*/
|
|
125
170
|
use(middleware) {
|
|
126
171
|
let builder = new Builder({
|
|
127
172
|
...this["~orpc"],
|
|
@@ -137,6 +182,12 @@ class Builder {
|
|
|
137
182
|
}
|
|
138
183
|
return builder;
|
|
139
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* Creates a standalone middleware that can be composed and applied to any
|
|
187
|
+
* compatible builder or procedure with `.use`.
|
|
188
|
+
*
|
|
189
|
+
* @see {@link https://orpc.dev/docs/middleware | Middleware}
|
|
190
|
+
*/
|
|
140
191
|
middleware(middleware) {
|
|
141
192
|
const allMiddlewares = [
|
|
142
193
|
...this["~orpc"].orderedMiddlewares.map(({ middleware: middleware2 }) => middleware2),
|
|
@@ -156,6 +207,11 @@ class Builder {
|
|
|
156
207
|
};
|
|
157
208
|
return current;
|
|
158
209
|
}
|
|
210
|
+
/**
|
|
211
|
+
* Defines the input schema used to validate and type the procedure input.
|
|
212
|
+
*
|
|
213
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
214
|
+
*/
|
|
159
215
|
input(schema) {
|
|
160
216
|
let builder = new Builder({
|
|
161
217
|
...this["~orpc"],
|
|
@@ -167,6 +223,11 @@ class Builder {
|
|
|
167
223
|
}
|
|
168
224
|
return builder;
|
|
169
225
|
}
|
|
226
|
+
/**
|
|
227
|
+
* Defines the output schema used to validate and type the procedure output.
|
|
228
|
+
*
|
|
229
|
+
* @see {@link https://orpc.dev/docs/procedure#inputoutput-validation | Procedure - Input/Output Validation}
|
|
230
|
+
*/
|
|
170
231
|
output(schema) {
|
|
171
232
|
let builder = new Builder({
|
|
172
233
|
...this["~orpc"],
|
|
@@ -178,6 +239,12 @@ class Builder {
|
|
|
178
239
|
}
|
|
179
240
|
return builder;
|
|
180
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* Defines the function that implements the procedure and completes the
|
|
244
|
+
* chain, returning a callable procedure.
|
|
245
|
+
*
|
|
246
|
+
* @see {@link https://orpc.dev/docs/procedure | Procedure}
|
|
247
|
+
*/
|
|
181
248
|
handler(handler) {
|
|
182
249
|
let procedure = new DecoratedProcedure({
|
|
183
250
|
...this["~orpc"],
|
|
@@ -189,14 +256,24 @@ class Builder {
|
|
|
189
256
|
}
|
|
190
257
|
return procedure;
|
|
191
258
|
}
|
|
259
|
+
/**
|
|
260
|
+
* Applies the builder's middleware, errors, and metadata to every procedure
|
|
261
|
+
* in the given router.
|
|
262
|
+
*
|
|
263
|
+
* @see {@link https://orpc.dev/docs/router#extending-router | Router - Extending Router}
|
|
264
|
+
*/
|
|
192
265
|
router(router) {
|
|
193
266
|
return augmentRouter(router, {
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
metaPlugins: this["~orpc"].metaPlugins,
|
|
197
|
-
errorMap: this["~orpc"].errorMap
|
|
267
|
+
...this["~orpc"],
|
|
268
|
+
middlewares: this["~orpc"].orderedMiddlewares.map(({ middleware }) => middleware)
|
|
198
269
|
});
|
|
199
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
* Like `.router`, but loads the router lazily on first access, which helps
|
|
273
|
+
* reduce startup time for large applications.
|
|
274
|
+
*
|
|
275
|
+
* @see {@link https://orpc.dev/docs/router#lazy-router | Router - Lazy Router}
|
|
276
|
+
*/
|
|
200
277
|
lazy(loader) {
|
|
201
278
|
return new Lazy({
|
|
202
279
|
loader: async () => {
|
|
@@ -256,15 +333,20 @@ class ImplementedProcedure extends Procedure {
|
|
|
256
333
|
}
|
|
257
334
|
|
|
258
335
|
class SharedRouterImplementer {
|
|
259
|
-
constructor(contract, middlewares) {
|
|
336
|
+
constructor(contract, config, middlewares) {
|
|
260
337
|
this.contract = contract;
|
|
338
|
+
this.config = config;
|
|
261
339
|
this.middlewares = middlewares;
|
|
262
340
|
}
|
|
263
|
-
static create(contract, middlewares = []) {
|
|
264
|
-
return new SharedRouterImplementer(
|
|
341
|
+
static create(contract, config, middlewares = []) {
|
|
342
|
+
return new SharedRouterImplementer(
|
|
343
|
+
contract,
|
|
344
|
+
config,
|
|
345
|
+
middlewares
|
|
346
|
+
);
|
|
265
347
|
}
|
|
266
348
|
use(middleware) {
|
|
267
|
-
return createRouterImplementerInternal(this.contract, [...this.middlewares, middleware]);
|
|
349
|
+
return createRouterImplementerInternal(this.contract, this.config, [...this.middlewares, middleware]);
|
|
268
350
|
}
|
|
269
351
|
middleware(middleware) {
|
|
270
352
|
const allMiddlewares = [
|
|
@@ -280,6 +362,7 @@ class SharedRouterImplementer {
|
|
|
280
362
|
router(router) {
|
|
281
363
|
if (this.middlewares.length) {
|
|
282
364
|
router = augmentImplementedRouter(router, {
|
|
365
|
+
...this.config,
|
|
283
366
|
middlewares: this.middlewares
|
|
284
367
|
});
|
|
285
368
|
}
|
|
@@ -292,6 +375,7 @@ class SharedRouterImplementer {
|
|
|
292
375
|
const { default: router } = await originalLoader();
|
|
293
376
|
return {
|
|
294
377
|
default: augmentImplementedRouter(router, {
|
|
378
|
+
...this.config,
|
|
295
379
|
middlewares: this.middlewares
|
|
296
380
|
})
|
|
297
381
|
};
|
|
@@ -300,12 +384,13 @@ class SharedRouterImplementer {
|
|
|
300
384
|
return new Lazy({ loader, meta: {} });
|
|
301
385
|
}
|
|
302
386
|
}
|
|
303
|
-
function createRouterImplementer(contract) {
|
|
304
|
-
return createRouterImplementerInternal(contract, []);
|
|
387
|
+
function createRouterImplementer(contract, config) {
|
|
388
|
+
return createRouterImplementerInternal(contract, config, []);
|
|
305
389
|
}
|
|
306
|
-
function createRouterImplementerInternal(contract, middlewares) {
|
|
390
|
+
function createRouterImplementerInternal(contract, config, middlewares) {
|
|
307
391
|
if (contract instanceof ProcedureContract) {
|
|
308
392
|
return new ProcedureImplementer({
|
|
393
|
+
...config,
|
|
309
394
|
...contract["~orpc"],
|
|
310
395
|
orderedMiddlewares: middlewares.map((middleware) => ({ middleware }))
|
|
311
396
|
});
|
|
@@ -313,16 +398,16 @@ function createRouterImplementerInternal(contract, middlewares) {
|
|
|
313
398
|
const implementer = {};
|
|
314
399
|
for (const key in contract) {
|
|
315
400
|
const child = contract[key];
|
|
316
|
-
implementer[key] = createRouterImplementerInternal(child, middlewares);
|
|
401
|
+
implementer[key] = createRouterImplementerInternal(child, config, middlewares);
|
|
317
402
|
}
|
|
318
|
-
const shared = bindMethods(SharedRouterImplementer.create(contract, middlewares));
|
|
403
|
+
const shared = bindMethods(SharedRouterImplementer.create(contract, config, middlewares));
|
|
319
404
|
for (const key in shared) {
|
|
320
405
|
const method = shared[key];
|
|
321
406
|
if (key in implementer) {
|
|
322
407
|
const child = implementer[key];
|
|
323
408
|
implementer[key] = new Proxy(method, {
|
|
324
409
|
get(_, p) {
|
|
325
|
-
return
|
|
410
|
+
return Reflect.get(child, p);
|
|
326
411
|
}
|
|
327
412
|
});
|
|
328
413
|
} else {
|
|
@@ -332,22 +417,24 @@ function createRouterImplementerInternal(contract, middlewares) {
|
|
|
332
417
|
return implementer;
|
|
333
418
|
}
|
|
334
419
|
|
|
335
|
-
function implement(contract) {
|
|
336
|
-
const routerImplementer = createRouterImplementer(contract);
|
|
420
|
+
function implement(contract, config = {}) {
|
|
421
|
+
const routerImplementer = createRouterImplementer(contract, config);
|
|
337
422
|
const implementer = new Proxy(routerImplementer, {
|
|
338
423
|
get(_, p) {
|
|
339
424
|
let method;
|
|
340
425
|
if (p === "$context") {
|
|
341
426
|
method = () => implementer;
|
|
427
|
+
} else if (p === "$config") {
|
|
428
|
+
method = (incoming) => implement(contract, { ...config, ...incoming });
|
|
342
429
|
}
|
|
343
|
-
const value =
|
|
430
|
+
const value = Reflect.get(routerImplementer, p);
|
|
344
431
|
if (method) {
|
|
345
432
|
if (!isTypescriptObject(value)) {
|
|
346
433
|
return method;
|
|
347
434
|
}
|
|
348
435
|
return new Proxy(method, {
|
|
349
436
|
get(_2, p2) {
|
|
350
|
-
return
|
|
437
|
+
return Reflect.get(value, p2);
|
|
351
438
|
}
|
|
352
439
|
});
|
|
353
440
|
}
|
|
@@ -363,19 +450,24 @@ function createRouterClient(router, ...rest) {
|
|
|
363
450
|
return createProcedureClient(router, options);
|
|
364
451
|
}
|
|
365
452
|
const procedureCaller = router instanceof Lazy ? createProcedureClient(createGuardedProcedureLazy(router), options) : {};
|
|
453
|
+
const cache = /* @__PURE__ */ new Map();
|
|
366
454
|
const recursive = new Proxy(procedureCaller, {
|
|
367
455
|
get(target, key) {
|
|
368
456
|
if (typeof key !== "string" || router instanceof Lazy && RECURSIVE_CLIENT_UNWRAP_KEYS.has(key)) {
|
|
369
|
-
return
|
|
457
|
+
return Reflect.get(target, key);
|
|
370
458
|
}
|
|
371
|
-
|
|
372
|
-
if (
|
|
373
|
-
|
|
459
|
+
let nextClient = cache.get(key);
|
|
460
|
+
if (nextClient === void 0) {
|
|
461
|
+
const next = getRouter(router, [key]);
|
|
462
|
+
if (!next) {
|
|
463
|
+
return Reflect.get(target, key);
|
|
464
|
+
}
|
|
465
|
+
nextClient = createRouterClient(next, {
|
|
466
|
+
...options,
|
|
467
|
+
path: [...toArray(options.path), key]
|
|
468
|
+
});
|
|
469
|
+
cache.set(key, nextClient);
|
|
374
470
|
}
|
|
375
|
-
const nextClient = createRouterClient(next, {
|
|
376
|
-
...options,
|
|
377
|
-
path: [...toArray(options.path), key]
|
|
378
|
-
});
|
|
379
471
|
return nextClient;
|
|
380
472
|
}
|
|
381
473
|
});
|