@temporary-name/server 1.9.3-alpha.4275e976ddda4d8be107c2cfde9899bdea9a337d → 1.9.3-alpha.50b729ba628b987e14f5bd1004e5a04590fd4b4e
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/dist/adapters/aws-lambda/index.d.mts +12 -6
- package/dist/adapters/aws-lambda/index.d.ts +12 -6
- package/dist/adapters/aws-lambda/index.mjs +12 -4
- package/dist/adapters/fetch/index.d.mts +12 -6
- package/dist/adapters/fetch/index.d.ts +12 -6
- package/dist/adapters/fetch/index.mjs +12 -11
- package/dist/adapters/node/index.d.mts +12 -6
- package/dist/adapters/node/index.d.ts +12 -6
- package/dist/adapters/node/index.mjs +12 -11
- package/dist/adapters/standard/index.d.mts +23 -13
- package/dist/adapters/standard/index.d.ts +23 -13
- package/dist/adapters/standard/index.mjs +8 -100
- package/dist/index.d.mts +44 -368
- package/dist/index.d.ts +44 -368
- package/dist/index.mjs +108 -152
- package/dist/openapi/index.d.mts +220 -0
- package/dist/openapi/index.d.ts +220 -0
- package/dist/openapi/index.mjs +776 -0
- package/dist/plugins/index.d.mts +2 -2
- package/dist/plugins/index.d.ts +2 -2
- package/dist/shared/server.BEHw7Eyx.mjs +247 -0
- package/dist/shared/server.BVxcyR6X.mjs +287 -0
- package/dist/shared/{server.Btxrgkj5.d.ts → server.Bk5r0-2R.d.ts} +7 -24
- package/dist/shared/server.Bs6ka_UE.d.mts +23 -0
- package/dist/shared/{server.C1YnHvvf.d.ts → server.CZNLCQBm.d.mts} +3 -3
- package/dist/shared/{server.C1YnHvvf.d.mts → server.CZNLCQBm.d.ts} +3 -3
- package/dist/shared/{server.Bo94xDTv.d.mts → server.CbLTWfgn.d.mts} +7 -24
- package/dist/shared/server.D2UFMrxf.d.ts +23 -0
- package/dist/shared/{server.BEQrAa3A.mjs → server.DcfsPloY.mjs} +16 -21
- package/package.json +19 -13
- package/dist/shared/server.D6K9uoPI.mjs +0 -35
- package/dist/shared/server.DZ5BIITo.mjs +0 -9
- package/dist/shared/server.X0YaZxSJ.mjs +0 -13
package/dist/index.mjs
CHANGED
|
@@ -1,50 +1,11 @@
|
|
|
1
|
-
import { isContractProcedure, mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, enhanceRoute, mergeTags, getContractRouter } from '@temporary-name/contract';
|
|
2
|
-
export { ValidationError, eventIterator, type, validateORPCError } from '@temporary-name/contract';
|
|
3
1
|
import { onError, resolveMaybeOptionalOptions } from '@temporary-name/shared';
|
|
4
2
|
export { AsyncIteratorClass, EventPublisher, ORPCError, asyncIteratorToStream as eventIteratorToStream, isDefinedError, onError, onFinish, onStart, onSuccess, safe, streamToAsyncIteratorClass as streamToEventIterator } from '@temporary-name/shared';
|
|
5
|
-
import {
|
|
6
|
-
|
|
7
|
-
|
|
3
|
+
import { isContractProcedure, mergePrefix, mergeErrorMap, enhanceRoute, mergeTags, ContractProcedure, mergeMeta, mergeRoute, prefixRoute, getContractRouter } from '@temporary-name/contract';
|
|
4
|
+
export { ValidationError, eventIterator, validateORPCError } from '@temporary-name/contract';
|
|
5
|
+
import { SchemaClass, gatingContext } from '@temporary-name/zod';
|
|
6
|
+
import { c as createProcedureClient, i as isLazy, g as getLazyMeta, l as lazy, u as unlazy } from './shared/server.DcfsPloY.mjs';
|
|
7
|
+
export { L as LAZY_SYMBOL, a as createORPCErrorConstructorMap, m as mergeCurrentContext, b as middlewareOutputFn } from './shared/server.DcfsPloY.mjs';
|
|
8
8
|
export { getEventMeta, withEventMeta } from '@temporary-name/standard-server';
|
|
9
|
-
import 'node:async_hooks';
|
|
10
|
-
import 'zod';
|
|
11
|
-
import 'zod/v4/core';
|
|
12
|
-
|
|
13
|
-
function decorateMiddleware(middleware) {
|
|
14
|
-
const decorated = ((...args) => middleware(...args));
|
|
15
|
-
decorated.mapInput = (mapInput) => {
|
|
16
|
-
const mapped = decorateMiddleware(
|
|
17
|
-
(options, input, ...rest) => middleware(options, mapInput(input), ...rest)
|
|
18
|
-
);
|
|
19
|
-
return mapped;
|
|
20
|
-
};
|
|
21
|
-
decorated.concat = (concatMiddleware, mapInput) => {
|
|
22
|
-
const mapped = mapInput ? decorateMiddleware(concatMiddleware).mapInput(mapInput) : concatMiddleware;
|
|
23
|
-
const concatted = decorateMiddleware((options, input, output, ...rest) => {
|
|
24
|
-
const merged = middleware(
|
|
25
|
-
{
|
|
26
|
-
...options,
|
|
27
|
-
next: (...[nextOptions1]) => mapped(
|
|
28
|
-
{
|
|
29
|
-
...options,
|
|
30
|
-
context: { ...options.context, ...nextOptions1?.context },
|
|
31
|
-
next: (...[nextOptions2]) => options.next({ context: { ...nextOptions1?.context, ...nextOptions2?.context } })
|
|
32
|
-
},
|
|
33
|
-
input,
|
|
34
|
-
output,
|
|
35
|
-
...rest
|
|
36
|
-
)
|
|
37
|
-
},
|
|
38
|
-
input,
|
|
39
|
-
output,
|
|
40
|
-
...rest
|
|
41
|
-
);
|
|
42
|
-
return merged;
|
|
43
|
-
});
|
|
44
|
-
return concatted;
|
|
45
|
-
};
|
|
46
|
-
return decorated;
|
|
47
|
-
}
|
|
48
9
|
|
|
49
10
|
function isStartWithMiddlewares(middlewares, compare) {
|
|
50
11
|
if (compare.length > middlewares.length) {
|
|
@@ -83,55 +44,10 @@ function isProcedure(item) {
|
|
|
83
44
|
if (item instanceof Procedure) {
|
|
84
45
|
return true;
|
|
85
46
|
}
|
|
86
|
-
return isContractProcedure(item) && "middlewares" in item["~orpc"] && "
|
|
47
|
+
return isContractProcedure(item) && "middlewares" in item["~orpc"] && "handler" in item["~orpc"];
|
|
87
48
|
}
|
|
88
49
|
|
|
89
50
|
class DecoratedProcedure extends Procedure {
|
|
90
|
-
/**
|
|
91
|
-
* Adds type-safe custom errors.
|
|
92
|
-
* The provided errors are spared-merged with any existing errors.
|
|
93
|
-
*
|
|
94
|
-
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
95
|
-
*/
|
|
96
|
-
errors(errors) {
|
|
97
|
-
return new DecoratedProcedure({
|
|
98
|
-
...this["~orpc"],
|
|
99
|
-
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
100
|
-
});
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Sets or updates the metadata.
|
|
104
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
105
|
-
*
|
|
106
|
-
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
107
|
-
*/
|
|
108
|
-
meta(meta) {
|
|
109
|
-
return new DecoratedProcedure({
|
|
110
|
-
...this["~orpc"],
|
|
111
|
-
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
112
|
-
});
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* Sets or updates the route definition.
|
|
116
|
-
* The provided route is spared-merged with any existing route.
|
|
117
|
-
* This option is typically relevant when integrating with OpenAPI.
|
|
118
|
-
*
|
|
119
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
120
|
-
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
121
|
-
*/
|
|
122
|
-
route(route) {
|
|
123
|
-
return new DecoratedProcedure({
|
|
124
|
-
...this["~orpc"],
|
|
125
|
-
route: mergeRoute(this["~orpc"].route, route)
|
|
126
|
-
});
|
|
127
|
-
}
|
|
128
|
-
use(middleware, mapInput) {
|
|
129
|
-
const mapped = mapInput ? decorateMiddleware(middleware).mapInput(mapInput) : middleware;
|
|
130
|
-
return new DecoratedProcedure({
|
|
131
|
-
...this["~orpc"],
|
|
132
|
-
middlewares: addMiddleware(this["~orpc"].middlewares, mapped)
|
|
133
|
-
});
|
|
134
|
-
}
|
|
135
51
|
/**
|
|
136
52
|
* Make this procedure callable (works like a function while still being a procedure).
|
|
137
53
|
*
|
|
@@ -296,87 +212,49 @@ async function unlazyRouter(router) {
|
|
|
296
212
|
return unlazied;
|
|
297
213
|
}
|
|
298
214
|
|
|
299
|
-
class
|
|
300
|
-
|
|
301
|
-
* This property holds the defined options.
|
|
302
|
-
*/
|
|
303
|
-
"~orpc";
|
|
215
|
+
class ProcedureBuilder extends ContractProcedure {
|
|
216
|
+
z;
|
|
304
217
|
constructor(def) {
|
|
305
|
-
|
|
218
|
+
super(def);
|
|
219
|
+
this.z = new SchemaClass();
|
|
306
220
|
}
|
|
307
221
|
/**
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
311
|
-
*/
|
|
312
|
-
$context() {
|
|
313
|
-
return this;
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* Creates a middleware.
|
|
317
|
-
*
|
|
318
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
319
|
-
*/
|
|
320
|
-
middleware(middleware) {
|
|
321
|
-
return decorateMiddleware(middleware);
|
|
322
|
-
}
|
|
323
|
-
/**
|
|
324
|
-
* Adds type-safe custom errors.
|
|
325
|
-
* The provided errors are spared-merged with any existing errors.
|
|
222
|
+
* Adds type-safe custom errors to the contract.
|
|
223
|
+
* The provided errors are spared-merged with any existing errors in the contract.
|
|
326
224
|
*
|
|
327
225
|
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
328
226
|
*/
|
|
329
227
|
errors(errors) {
|
|
330
|
-
return new
|
|
228
|
+
return new ProcedureBuilder({
|
|
331
229
|
...this["~orpc"],
|
|
332
230
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
333
231
|
});
|
|
334
232
|
}
|
|
335
233
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
* @info Supports both normal middleware and inline middleware implementations.
|
|
339
|
-
* @note The current context must be satisfy middleware dependent-context
|
|
340
|
-
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
341
|
-
*/
|
|
342
|
-
use(middleware) {
|
|
343
|
-
return new Builder({
|
|
344
|
-
...this["~orpc"],
|
|
345
|
-
middlewares: addMiddleware(this["~orpc"].middlewares, middleware)
|
|
346
|
-
});
|
|
347
|
-
}
|
|
348
|
-
useGating(gates, isGateEnabled) {
|
|
349
|
-
return this.use(({ next, context }) => {
|
|
350
|
-
return gatingContext.run(
|
|
351
|
-
(gate) => isGateEnabled(gate, context),
|
|
352
|
-
() => next({ context: { isGateEnabled } })
|
|
353
|
-
);
|
|
354
|
-
});
|
|
355
|
-
}
|
|
356
|
-
/**
|
|
357
|
-
* Sets or updates the metadata.
|
|
358
|
-
* The provided metadata is spared-merged with any existing metadata.
|
|
234
|
+
* Sets or updates the metadata for the contract.
|
|
235
|
+
* The provided metadata is spared-merged with any existing metadata in the contract.
|
|
359
236
|
*
|
|
360
237
|
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
361
238
|
*/
|
|
362
239
|
meta(meta) {
|
|
363
|
-
return new
|
|
240
|
+
return new ProcedureBuilder({
|
|
364
241
|
...this["~orpc"],
|
|
365
242
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
366
243
|
});
|
|
367
244
|
}
|
|
368
245
|
/**
|
|
369
|
-
* Sets or updates the route definition.
|
|
370
|
-
* The provided route is spared-merged with any existing route.
|
|
246
|
+
* Sets or updates the route definition for the contract.
|
|
247
|
+
* The provided route is spared-merged with any existing route in the contract.
|
|
371
248
|
* This option is typically relevant when integrating with OpenAPI.
|
|
372
249
|
*
|
|
373
250
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
374
251
|
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
375
252
|
*/
|
|
376
253
|
route(route) {
|
|
377
|
-
|
|
254
|
+
const { prefix } = this["~orpc"];
|
|
255
|
+
return new ProcedureBuilder({
|
|
378
256
|
...this["~orpc"],
|
|
379
|
-
route: mergeRoute(this["~orpc"].route, route)
|
|
257
|
+
route: mergeRoute(this["~orpc"].route, prefix ? prefixRoute(route, prefix) : route)
|
|
380
258
|
});
|
|
381
259
|
}
|
|
382
260
|
/**
|
|
@@ -385,7 +263,7 @@ class Builder {
|
|
|
385
263
|
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
386
264
|
*/
|
|
387
265
|
input(schema) {
|
|
388
|
-
return new
|
|
266
|
+
return new ProcedureBuilder({
|
|
389
267
|
...this["~orpc"],
|
|
390
268
|
inputSchema: schema,
|
|
391
269
|
inputValidationIndex: this["~orpc"].middlewares.length
|
|
@@ -397,12 +275,33 @@ class Builder {
|
|
|
397
275
|
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
398
276
|
*/
|
|
399
277
|
output(schema) {
|
|
400
|
-
return new
|
|
278
|
+
return new ProcedureBuilder({
|
|
401
279
|
...this["~orpc"],
|
|
402
280
|
outputSchema: schema,
|
|
403
281
|
outputValidationIndex: this["~orpc"].middlewares.length
|
|
404
282
|
});
|
|
405
283
|
}
|
|
284
|
+
/**
|
|
285
|
+
* Uses a middleware to modify the context or improve the pipeline.
|
|
286
|
+
*
|
|
287
|
+
* @info Supports both normal middleware and inline middleware implementations.
|
|
288
|
+
* @note The current context must be satisfy middleware dependent-context
|
|
289
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
290
|
+
*/
|
|
291
|
+
use(middleware) {
|
|
292
|
+
return new this.constructor({
|
|
293
|
+
...this["~orpc"],
|
|
294
|
+
middlewares: addMiddleware(this["~orpc"].middlewares, middleware)
|
|
295
|
+
});
|
|
296
|
+
}
|
|
297
|
+
useGating(gates, isGateEnabled) {
|
|
298
|
+
return this.use(({ next, context }) => {
|
|
299
|
+
return gatingContext.run(
|
|
300
|
+
(gate) => isGateEnabled(gate, context),
|
|
301
|
+
() => next({ context: { isGateEnabled } })
|
|
302
|
+
);
|
|
303
|
+
});
|
|
304
|
+
}
|
|
406
305
|
/**
|
|
407
306
|
* Defines the handler of the procedure.
|
|
408
307
|
*
|
|
@@ -414,6 +313,8 @@ class Builder {
|
|
|
414
313
|
handler
|
|
415
314
|
});
|
|
416
315
|
}
|
|
316
|
+
}
|
|
317
|
+
class BuilderWithMiddlewares extends ProcedureBuilder {
|
|
417
318
|
/**
|
|
418
319
|
* Prefixes all procedures in the router.
|
|
419
320
|
* The provided prefix is post-appended to any existing router prefix.
|
|
@@ -423,7 +324,7 @@ class Builder {
|
|
|
423
324
|
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
424
325
|
*/
|
|
425
326
|
prefix(prefix) {
|
|
426
|
-
return new
|
|
327
|
+
return new this.constructor({
|
|
427
328
|
...this["~orpc"],
|
|
428
329
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
|
429
330
|
});
|
|
@@ -435,7 +336,7 @@ class Builder {
|
|
|
435
336
|
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
436
337
|
*/
|
|
437
338
|
tag(...tags) {
|
|
438
|
-
return new
|
|
339
|
+
return new this.constructor({
|
|
439
340
|
...this["~orpc"],
|
|
440
341
|
tags: mergeTags(this["~orpc"].tags, tags)
|
|
441
342
|
});
|
|
@@ -455,18 +356,74 @@ class Builder {
|
|
|
455
356
|
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
456
357
|
*/
|
|
457
358
|
lazyRoute(loader) {
|
|
458
|
-
|
|
359
|
+
const lazied = lazy(loader);
|
|
360
|
+
return enhanceRouter(lazied, this["~orpc"]);
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
function decorateMiddleware(middleware) {
|
|
365
|
+
const decorated = ((...args) => middleware(...args));
|
|
366
|
+
decorated.mapInput = (mapInput) => {
|
|
367
|
+
const mapped = decorateMiddleware(
|
|
368
|
+
(options, input, ...rest) => middleware(options, mapInput(input), ...rest)
|
|
369
|
+
);
|
|
370
|
+
return mapped;
|
|
371
|
+
};
|
|
372
|
+
decorated.concat = (concatMiddleware, mapInput) => {
|
|
373
|
+
const mapped = mapInput ? decorateMiddleware(concatMiddleware).mapInput(mapInput) : concatMiddleware;
|
|
374
|
+
const concatted = decorateMiddleware((options, input, output, ...rest) => {
|
|
375
|
+
const merged = middleware(
|
|
376
|
+
{
|
|
377
|
+
...options,
|
|
378
|
+
next: (...[nextOptions1]) => mapped(
|
|
379
|
+
{
|
|
380
|
+
...options,
|
|
381
|
+
context: { ...options.context, ...nextOptions1?.context },
|
|
382
|
+
next: (...[nextOptions2]) => options.next({ context: { ...nextOptions1?.context, ...nextOptions2?.context } })
|
|
383
|
+
},
|
|
384
|
+
input,
|
|
385
|
+
output,
|
|
386
|
+
...rest
|
|
387
|
+
)
|
|
388
|
+
},
|
|
389
|
+
input,
|
|
390
|
+
output,
|
|
391
|
+
...rest
|
|
392
|
+
);
|
|
393
|
+
return merged;
|
|
394
|
+
});
|
|
395
|
+
return concatted;
|
|
396
|
+
};
|
|
397
|
+
return decorated;
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
class Builder extends BuilderWithMiddlewares {
|
|
401
|
+
/**
|
|
402
|
+
* Set or override the initial context.
|
|
403
|
+
*
|
|
404
|
+
* @see {@link https://orpc.unnoq.com/docs/context Context Docs}
|
|
405
|
+
*/
|
|
406
|
+
$context() {
|
|
407
|
+
return this;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Creates a middleware.
|
|
411
|
+
*
|
|
412
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
413
|
+
*/
|
|
414
|
+
middleware(middleware) {
|
|
415
|
+
return decorateMiddleware(middleware);
|
|
459
416
|
}
|
|
460
417
|
}
|
|
461
418
|
function createApiBuilder(opts = {}) {
|
|
462
|
-
|
|
419
|
+
return new Builder({
|
|
463
420
|
route: {},
|
|
464
421
|
meta: opts.meta ?? {},
|
|
465
422
|
errorMap: {},
|
|
466
423
|
inputValidationIndex: 0,
|
|
467
424
|
outputValidationIndex: 0,
|
|
468
425
|
middlewares: [
|
|
469
|
-
onError((error,
|
|
426
|
+
onError((error, _options) => {
|
|
470
427
|
console.dir(error, { depth: null });
|
|
471
428
|
})
|
|
472
429
|
],
|
|
@@ -474,7 +431,6 @@ function createApiBuilder(opts = {}) {
|
|
|
474
431
|
// the best solution). For now I've removed the interface to configure it externally.
|
|
475
432
|
dedupeLeadingMiddlewares: true
|
|
476
433
|
});
|
|
477
|
-
return base;
|
|
478
434
|
}
|
|
479
435
|
const os = createApiBuilder();
|
|
480
436
|
|
|
@@ -615,4 +571,4 @@ function createRouterClient(router, ...rest) {
|
|
|
615
571
|
return recursive;
|
|
616
572
|
}
|
|
617
573
|
|
|
618
|
-
export { Builder, DecoratedProcedure, Procedure, addMiddleware, call, createAccessibleLazyRouter, createApiBuilder, createAssertedLazyProcedure, createContractedProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, getHiddenRouterContract, getLazyMeta, getRouter, implement, implementerInternal, isLazy, isProcedure, isStartWithMiddlewares, lazy, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazy, unlazyRouter };
|
|
574
|
+
export { Builder, BuilderWithMiddlewares, DecoratedProcedure, Procedure, ProcedureBuilder, addMiddleware, call, createAccessibleLazyRouter, createApiBuilder, createAssertedLazyProcedure, createContractedProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, getHiddenRouterContract, getLazyMeta, getRouter, implement, implementerInternal, isLazy, isProcedure, isStartWithMiddlewares, lazy, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazy, unlazyRouter };
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
import { OpenAPI, AnyContractProcedure, AnySchema, AnyContractRouter } from '@temporary-name/contract';
|
|
2
|
+
export { OpenAPI } from '@temporary-name/contract';
|
|
3
|
+
import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter, ORPCError, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@temporary-name/server';
|
|
4
|
+
import { Promisable, Value, HTTPPath, HTTPMethod, NestedClient, Client, MaybeOptionalOptions } from '@temporary-name/shared';
|
|
5
|
+
import { JSONSchema } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
|
|
6
|
+
export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
|
|
7
|
+
|
|
8
|
+
type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
|
|
9
|
+
/**
|
|
10
|
+
* Customize The Operation Object by proxy an error map item or a middleware.
|
|
11
|
+
*
|
|
12
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
|
|
13
|
+
*/
|
|
14
|
+
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
15
|
+
declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
|
|
16
|
+
declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
*/
|
|
21
|
+
type ObjectSchema = JSONSchema & {
|
|
22
|
+
type: 'object';
|
|
23
|
+
} & object;
|
|
24
|
+
/**
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
27
|
+
type FileSchema = JSONSchema & {
|
|
28
|
+
type: 'string';
|
|
29
|
+
contentMediaType: string;
|
|
30
|
+
} & object;
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
declare const LOGIC_KEYWORDS: string[];
|
|
35
|
+
|
|
36
|
+
interface SchemaConverterComponent {
|
|
37
|
+
allowedStrategies: readonly SchemaConvertOptions['strategy'][];
|
|
38
|
+
schema: AnySchema;
|
|
39
|
+
required: boolean;
|
|
40
|
+
ref: string;
|
|
41
|
+
}
|
|
42
|
+
interface SchemaConvertOptions {
|
|
43
|
+
strategy: 'input' | 'output';
|
|
44
|
+
/**
|
|
45
|
+
* Common components should use `$ref` to represent themselves if matched.
|
|
46
|
+
*/
|
|
47
|
+
components?: readonly SchemaConverterComponent[];
|
|
48
|
+
/**
|
|
49
|
+
* Minimum schema structure depth required before using `$ref` for components.
|
|
50
|
+
*
|
|
51
|
+
* For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
|
|
52
|
+
*
|
|
53
|
+
* @default 0 - No depth limit;
|
|
54
|
+
*/
|
|
55
|
+
minStructureDepthForRef?: number;
|
|
56
|
+
}
|
|
57
|
+
interface SchemaConverter {
|
|
58
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
|
|
59
|
+
}
|
|
60
|
+
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
61
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
|
|
62
|
+
}
|
|
63
|
+
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
64
|
+
private readonly converters;
|
|
65
|
+
constructor(converters: readonly ConditionalSchemaConverter[]);
|
|
66
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
interface OpenAPIGeneratorOptions {
|
|
70
|
+
schemaConverters?: ConditionalSchemaConverter[];
|
|
71
|
+
}
|
|
72
|
+
interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
|
|
73
|
+
/**
|
|
74
|
+
* Exclude procedures from the OpenAPI specification.
|
|
75
|
+
*
|
|
76
|
+
* @deprecated Use `filter` option instead.
|
|
77
|
+
* @default () => false
|
|
78
|
+
*/
|
|
79
|
+
exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
|
|
80
|
+
/**
|
|
81
|
+
* Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
|
|
82
|
+
*
|
|
83
|
+
* @default true
|
|
84
|
+
*/
|
|
85
|
+
filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
|
|
86
|
+
/**
|
|
87
|
+
* Common schemas to be used for $ref resolution.
|
|
88
|
+
*/
|
|
89
|
+
commonSchemas?: Record<string, {
|
|
90
|
+
/**
|
|
91
|
+
* Determines which schema definition to use when input and output schemas differ.
|
|
92
|
+
* This is needed because some schemas transform data differently between input and output,
|
|
93
|
+
* making it impossible to use a single $ref for both cases.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```ts
|
|
97
|
+
* // This schema transforms a string input into a number output
|
|
98
|
+
* const Schema = z.string()
|
|
99
|
+
* .transform(v => Number(v))
|
|
100
|
+
* .pipe(z.number())
|
|
101
|
+
*
|
|
102
|
+
* // Input schema: { type: 'string' }
|
|
103
|
+
* // Output schema: { type: 'number' }
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* When schemas differ between input and output, you must explicitly choose
|
|
107
|
+
* which version to use for the OpenAPI specification.
|
|
108
|
+
*
|
|
109
|
+
* @default 'input' - Uses the input schema definition by default
|
|
110
|
+
*/
|
|
111
|
+
strategy?: SchemaConvertOptions['strategy'];
|
|
112
|
+
schema: AnySchema;
|
|
113
|
+
} | {
|
|
114
|
+
error: 'UndefinedError';
|
|
115
|
+
schema?: never;
|
|
116
|
+
}>;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* The generator that converts oRPC routers/contracts to OpenAPI specifications.
|
|
120
|
+
*
|
|
121
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
122
|
+
*/
|
|
123
|
+
declare class OpenAPIGenerator {
|
|
124
|
+
#private;
|
|
125
|
+
private readonly converter;
|
|
126
|
+
constructor(options?: OpenAPIGeneratorOptions);
|
|
127
|
+
/**
|
|
128
|
+
* Generates OpenAPI specifications from oRPC routers/contracts.
|
|
129
|
+
*
|
|
130
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
131
|
+
*/
|
|
132
|
+
generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* @internal
|
|
137
|
+
*/
|
|
138
|
+
declare function toOpenAPIPath(path: HTTPPath): string;
|
|
139
|
+
/**
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
|
+
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
*/
|
|
146
|
+
declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
|
|
147
|
+
/**
|
|
148
|
+
* @internal
|
|
149
|
+
*/
|
|
150
|
+
declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
|
|
151
|
+
/**
|
|
152
|
+
* @internal
|
|
153
|
+
*/
|
|
154
|
+
declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
|
|
155
|
+
/**
|
|
156
|
+
* @internal
|
|
157
|
+
*/
|
|
158
|
+
declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
|
|
159
|
+
/**
|
|
160
|
+
* @internal
|
|
161
|
+
*/
|
|
162
|
+
declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
|
|
163
|
+
declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
|
|
164
|
+
|
|
165
|
+
type JsonifiedValue<T> = T extends string ? T : T extends number ? T : T extends boolean ? T : T extends null ? T : T extends undefined ? T : T extends Array<unknown> ? JsonifiedArray<T> : T extends Record<string, unknown> ? {
|
|
166
|
+
[K in keyof T]: JsonifiedValue<T[K]>;
|
|
167
|
+
} : T extends Date ? string : T extends bigint ? string : T extends File ? File : T extends Blob ? Blob : T extends RegExp ? string : T extends URL ? string : T extends Map<infer K, infer V> ? JsonifiedArray<[K, V][]> : T extends Set<infer U> ? JsonifiedArray<U[]> : T extends AsyncIteratorObject<infer U, infer V> ? AsyncIteratorObject<JsonifiedValue<U>, JsonifiedValue<V>> : unknown;
|
|
168
|
+
type JsonifiedArray<T extends Array<unknown>> = T extends readonly [] ? [] : T extends readonly [infer U, ...infer V] ? [
|
|
169
|
+
U extends undefined ? null : JsonifiedValue<U>,
|
|
170
|
+
...JsonifiedArray<V>
|
|
171
|
+
] : T extends Array<infer U> ? Array<JsonifiedValue<U>> : unknown;
|
|
172
|
+
/**
|
|
173
|
+
* Convert types that JSON not support to corresponding json types
|
|
174
|
+
*
|
|
175
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/client/openapi-link OpenAPI Link Docs}
|
|
176
|
+
*/
|
|
177
|
+
type JsonifiedClient<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? Client<UClientContext, UInput, JsonifiedValue<UOutput>, UError extends ORPCError<infer UCode, infer UData> ? ORPCError<UCode, JsonifiedValue<UData>> : UError> : {
|
|
178
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? JsonifiedClient<T[K]> : T[K];
|
|
179
|
+
};
|
|
180
|
+
declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
*@internal
|
|
184
|
+
*/
|
|
185
|
+
declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
|
|
186
|
+
/**
|
|
187
|
+
* @internal
|
|
188
|
+
*/
|
|
189
|
+
declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
|
|
190
|
+
/**
|
|
191
|
+
* @internal
|
|
192
|
+
*/
|
|
193
|
+
declare function isAnySchema(schema: JSONSchema): boolean;
|
|
194
|
+
/**
|
|
195
|
+
* @internal
|
|
196
|
+
*/
|
|
197
|
+
declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
|
|
198
|
+
/**
|
|
199
|
+
* @internal
|
|
200
|
+
*/
|
|
201
|
+
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
202
|
+
declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
|
|
203
|
+
/**
|
|
204
|
+
* Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
|
|
205
|
+
* recursively expands it into an array of its constituent, non-union base schemas.
|
|
206
|
+
* If the schema is not a simple union or is a base type, it's returned as a single-element array.
|
|
207
|
+
*/
|
|
208
|
+
declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
|
|
209
|
+
declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
|
|
210
|
+
type: 'array';
|
|
211
|
+
items?: JSONSchema;
|
|
212
|
+
}];
|
|
213
|
+
declare function isPrimitiveSchema(schema: JSONSchema): boolean;
|
|
214
|
+
|
|
215
|
+
declare const oo: {
|
|
216
|
+
spec: typeof customOpenAPIOperation;
|
|
217
|
+
};
|
|
218
|
+
|
|
219
|
+
export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
220
|
+
export type { ConditionalSchemaConverter, FileSchema, JsonifiedArray, JsonifiedClient, JsonifiedValue, ObjectSchema, OpenAPIGeneratorGenerateOptions, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter, SchemaConverterComponent };
|