@orpc/contract 0.0.0-next.b0f324e → 0.0.0-next.b12bcdb
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 +30 -20
- package/dist/index.d.mts +242 -169
- package/dist/index.d.ts +242 -169
- package/dist/index.mjs +141 -56
- package/dist/plugins/index.d.mts +24 -0
- package/dist/plugins/index.d.ts +24 -0
- package/dist/plugins/index.mjs +43 -0
- package/dist/shared/contract.CvRxURhn.d.mts +254 -0
- package/dist/shared/contract.CvRxURhn.d.ts +254 -0
- package/dist/shared/contract.D_dZrO__.mjs +53 -0
- package/package.json +12 -7
package/dist/index.mjs
CHANGED
|
@@ -1,41 +1,13 @@
|
|
|
1
|
+
import { i as isContractProcedure, C as ContractProcedure, m as mergeErrorMap, V as ValidationError } from './shared/contract.D_dZrO__.mjs';
|
|
2
|
+
export { v as validateORPCError } from './shared/contract.D_dZrO__.mjs';
|
|
1
3
|
import { mapEventIterator, ORPCError } from '@orpc/client';
|
|
2
4
|
export { ORPCError } from '@orpc/client';
|
|
3
|
-
import { isAsyncIteratorObject } from '@orpc/shared';
|
|
4
|
-
|
|
5
|
-
class ValidationError extends Error {
|
|
6
|
-
issues;
|
|
7
|
-
constructor(options) {
|
|
8
|
-
super(options.message, options);
|
|
9
|
-
this.issues = options.issues;
|
|
10
|
-
}
|
|
11
|
-
}
|
|
12
|
-
function mergeErrorMap(errorMap1, errorMap2) {
|
|
13
|
-
return { ...errorMap1, ...errorMap2 };
|
|
14
|
-
}
|
|
5
|
+
import { isAsyncIteratorObject, get, isTypescriptObject, isPropertyKey } from '@orpc/shared';
|
|
15
6
|
|
|
16
7
|
function mergeMeta(meta1, meta2) {
|
|
17
8
|
return { ...meta1, ...meta2 };
|
|
18
9
|
}
|
|
19
10
|
|
|
20
|
-
class ContractProcedure {
|
|
21
|
-
"~orpc";
|
|
22
|
-
constructor(def) {
|
|
23
|
-
if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
|
|
24
|
-
throw new Error("[ContractProcedure] The successStatus must be between 200 and 299");
|
|
25
|
-
}
|
|
26
|
-
if (Object.values(def.errorMap).some((val) => val && val.status && (val.status < 400 || val.status > 599))) {
|
|
27
|
-
throw new Error("[ContractProcedure] The error status code must be in the 400-599 range.");
|
|
28
|
-
}
|
|
29
|
-
this["~orpc"] = def;
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
function isContractProcedure(item) {
|
|
33
|
-
if (item instanceof ContractProcedure) {
|
|
34
|
-
return true;
|
|
35
|
-
}
|
|
36
|
-
return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "inputSchema" in item["~orpc"] && "outputSchema" in item["~orpc"] && "errorMap" in item["~orpc"] && "route" in item["~orpc"] && "meta" in item["~orpc"];
|
|
37
|
-
}
|
|
38
|
-
|
|
39
11
|
function mergeRoute(a, b) {
|
|
40
12
|
return { ...a, ...b };
|
|
41
13
|
}
|
|
@@ -60,31 +32,62 @@ function mergePrefix(a, b) {
|
|
|
60
32
|
function mergeTags(a, b) {
|
|
61
33
|
return a ? [...a, ...b] : b;
|
|
62
34
|
}
|
|
63
|
-
function
|
|
35
|
+
function enhanceRoute(route, options) {
|
|
64
36
|
let router = route;
|
|
65
37
|
if (options.prefix) {
|
|
66
38
|
router = prefixRoute(router, options.prefix);
|
|
67
39
|
}
|
|
68
|
-
if (options.tags) {
|
|
40
|
+
if (options.tags?.length) {
|
|
69
41
|
router = unshiftTagRoute(router, options.tags);
|
|
70
42
|
}
|
|
71
43
|
return router;
|
|
72
44
|
}
|
|
73
45
|
|
|
74
|
-
function
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
46
|
+
function getContractRouter(router, path) {
|
|
47
|
+
let current = router;
|
|
48
|
+
for (let i = 0; i < path.length; i++) {
|
|
49
|
+
const segment = path[i];
|
|
50
|
+
if (!current) {
|
|
51
|
+
return void 0;
|
|
52
|
+
}
|
|
53
|
+
if (isContractProcedure(current)) {
|
|
54
|
+
return void 0;
|
|
55
|
+
}
|
|
56
|
+
current = current[segment];
|
|
57
|
+
}
|
|
58
|
+
return current;
|
|
59
|
+
}
|
|
60
|
+
function enhanceContractRouter(router, options) {
|
|
61
|
+
if (isContractProcedure(router)) {
|
|
62
|
+
const enhanced2 = new ContractProcedure({
|
|
63
|
+
...router["~orpc"],
|
|
64
|
+
errorMap: mergeErrorMap(options.errorMap, router["~orpc"].errorMap),
|
|
65
|
+
route: enhanceRoute(router["~orpc"].route, options)
|
|
80
66
|
});
|
|
81
|
-
return
|
|
67
|
+
return enhanced2;
|
|
82
68
|
}
|
|
83
|
-
const
|
|
84
|
-
for (const key in
|
|
85
|
-
|
|
69
|
+
const enhanced = {};
|
|
70
|
+
for (const key in router) {
|
|
71
|
+
enhanced[key] = enhanceContractRouter(router[key], options);
|
|
86
72
|
}
|
|
87
|
-
return
|
|
73
|
+
return enhanced;
|
|
74
|
+
}
|
|
75
|
+
function minifyContractRouter(router) {
|
|
76
|
+
if (isContractProcedure(router)) {
|
|
77
|
+
const procedure = {
|
|
78
|
+
"~orpc": {
|
|
79
|
+
errorMap: {},
|
|
80
|
+
meta: router["~orpc"].meta,
|
|
81
|
+
route: router["~orpc"].route
|
|
82
|
+
}
|
|
83
|
+
};
|
|
84
|
+
return procedure;
|
|
85
|
+
}
|
|
86
|
+
const json = {};
|
|
87
|
+
for (const key in router) {
|
|
88
|
+
json[key] = minifyContractRouter(router[key]);
|
|
89
|
+
}
|
|
90
|
+
return json;
|
|
88
91
|
}
|
|
89
92
|
|
|
90
93
|
class ContractBuilder extends ContractProcedure {
|
|
@@ -94,7 +97,9 @@ class ContractBuilder extends ContractProcedure {
|
|
|
94
97
|
this["~orpc"].tags = def.tags;
|
|
95
98
|
}
|
|
96
99
|
/**
|
|
97
|
-
*
|
|
100
|
+
* Sets or overrides the initial meta.
|
|
101
|
+
*
|
|
102
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
98
103
|
*/
|
|
99
104
|
$meta(initialMeta) {
|
|
100
105
|
return new ContractBuilder({
|
|
@@ -103,7 +108,11 @@ class ContractBuilder extends ContractProcedure {
|
|
|
103
108
|
});
|
|
104
109
|
}
|
|
105
110
|
/**
|
|
106
|
-
*
|
|
111
|
+
* Sets or overrides the initial route.
|
|
112
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
113
|
+
*
|
|
114
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
115
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
107
116
|
*/
|
|
108
117
|
$route(initialRoute) {
|
|
109
118
|
return new ContractBuilder({
|
|
@@ -111,56 +120,103 @@ class ContractBuilder extends ContractProcedure {
|
|
|
111
120
|
route: initialRoute
|
|
112
121
|
});
|
|
113
122
|
}
|
|
123
|
+
/**
|
|
124
|
+
* Adds type-safe custom errors to the contract.
|
|
125
|
+
* The provided errors are spared-merged with any existing errors in the contract.
|
|
126
|
+
*
|
|
127
|
+
* @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
|
|
128
|
+
*/
|
|
114
129
|
errors(errors) {
|
|
115
130
|
return new ContractBuilder({
|
|
116
131
|
...this["~orpc"],
|
|
117
132
|
errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
|
|
118
133
|
});
|
|
119
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* Sets or updates the metadata for the contract.
|
|
137
|
+
* The provided metadata is spared-merged with any existing metadata in the contract.
|
|
138
|
+
*
|
|
139
|
+
* @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
|
|
140
|
+
*/
|
|
120
141
|
meta(meta) {
|
|
121
142
|
return new ContractBuilder({
|
|
122
143
|
...this["~orpc"],
|
|
123
144
|
meta: mergeMeta(this["~orpc"].meta, meta)
|
|
124
145
|
});
|
|
125
146
|
}
|
|
147
|
+
/**
|
|
148
|
+
* Sets or updates the route definition for the contract.
|
|
149
|
+
* The provided route is spared-merged with any existing route in the contract.
|
|
150
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
151
|
+
*
|
|
152
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
153
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
154
|
+
*/
|
|
126
155
|
route(route) {
|
|
127
156
|
return new ContractBuilder({
|
|
128
157
|
...this["~orpc"],
|
|
129
158
|
route: mergeRoute(this["~orpc"].route, route)
|
|
130
159
|
});
|
|
131
160
|
}
|
|
161
|
+
/**
|
|
162
|
+
* Defines the input validation schema for the contract.
|
|
163
|
+
*
|
|
164
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
|
|
165
|
+
*/
|
|
132
166
|
input(schema) {
|
|
133
167
|
return new ContractBuilder({
|
|
134
168
|
...this["~orpc"],
|
|
135
169
|
inputSchema: schema
|
|
136
170
|
});
|
|
137
171
|
}
|
|
172
|
+
/**
|
|
173
|
+
* Defines the output validation schema for the contract.
|
|
174
|
+
*
|
|
175
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
|
|
176
|
+
*/
|
|
138
177
|
output(schema) {
|
|
139
178
|
return new ContractBuilder({
|
|
140
179
|
...this["~orpc"],
|
|
141
180
|
outputSchema: schema
|
|
142
181
|
});
|
|
143
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* Prefixes all procedures in the contract router.
|
|
185
|
+
* The provided prefix is post-appended to any existing router prefix.
|
|
186
|
+
*
|
|
187
|
+
* @note This option does not affect procedures that do not define a path in their route definition.
|
|
188
|
+
*
|
|
189
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
|
|
190
|
+
*/
|
|
144
191
|
prefix(prefix) {
|
|
145
192
|
return new ContractBuilder({
|
|
146
193
|
...this["~orpc"],
|
|
147
194
|
prefix: mergePrefix(this["~orpc"].prefix, prefix)
|
|
148
195
|
});
|
|
149
196
|
}
|
|
197
|
+
/**
|
|
198
|
+
* Adds tags to all procedures in the contract router.
|
|
199
|
+
* This helpful when you want to group procedures together in the OpenAPI specification.
|
|
200
|
+
*
|
|
201
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
202
|
+
*/
|
|
150
203
|
tag(...tags) {
|
|
151
204
|
return new ContractBuilder({
|
|
152
205
|
...this["~orpc"],
|
|
153
206
|
tags: mergeTags(this["~orpc"].tags, tags)
|
|
154
207
|
});
|
|
155
208
|
}
|
|
209
|
+
/**
|
|
210
|
+
* Applies all of the previously defined options to the specified contract router.
|
|
211
|
+
*
|
|
212
|
+
* @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
|
|
213
|
+
*/
|
|
156
214
|
router(router) {
|
|
157
|
-
return
|
|
215
|
+
return enhanceContractRouter(router, this["~orpc"]);
|
|
158
216
|
}
|
|
159
217
|
}
|
|
160
218
|
const oc = new ContractBuilder({
|
|
161
219
|
errorMap: {},
|
|
162
|
-
inputSchema: void 0,
|
|
163
|
-
outputSchema: void 0,
|
|
164
220
|
route: {},
|
|
165
221
|
meta: {}
|
|
166
222
|
});
|
|
@@ -179,16 +235,16 @@ function fallbackContractConfig(key, value) {
|
|
|
179
235
|
return value;
|
|
180
236
|
}
|
|
181
237
|
|
|
182
|
-
const
|
|
238
|
+
const EVENT_ITERATOR_DETAILS_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_DETAILS");
|
|
183
239
|
function eventIterator(yields, returns) {
|
|
184
240
|
return {
|
|
185
241
|
"~standard": {
|
|
186
|
-
[
|
|
242
|
+
[EVENT_ITERATOR_DETAILS_SYMBOL]: { yields, returns },
|
|
187
243
|
vendor: "orpc",
|
|
188
244
|
version: 1,
|
|
189
245
|
validate(iterator) {
|
|
190
246
|
if (!isAsyncIteratorObject(iterator)) {
|
|
191
|
-
return { issues: [{ message: "Expect event
|
|
247
|
+
return { issues: [{ message: "Expect event iterator", path: [] }] };
|
|
192
248
|
}
|
|
193
249
|
const mapped = mapEventIterator(iterator, {
|
|
194
250
|
async value(value, done) {
|
|
@@ -199,10 +255,11 @@ function eventIterator(yields, returns) {
|
|
|
199
255
|
const result = await schema["~standard"].validate(value);
|
|
200
256
|
if (result.issues) {
|
|
201
257
|
throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
|
|
202
|
-
message: "Event
|
|
258
|
+
message: "Event iterator validation failed",
|
|
203
259
|
cause: new ValidationError({
|
|
204
260
|
issues: result.issues,
|
|
205
|
-
message: "Event
|
|
261
|
+
message: "Event iterator validation failed",
|
|
262
|
+
data: value
|
|
206
263
|
})
|
|
207
264
|
});
|
|
208
265
|
}
|
|
@@ -219,7 +276,20 @@ function getEventIteratorSchemaDetails(schema) {
|
|
|
219
276
|
if (schema === void 0) {
|
|
220
277
|
return void 0;
|
|
221
278
|
}
|
|
222
|
-
return schema["~standard"][
|
|
279
|
+
return schema["~standard"][EVENT_ITERATOR_DETAILS_SYMBOL];
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
function inferRPCMethodFromContractRouter(contract) {
|
|
283
|
+
return (_, path) => {
|
|
284
|
+
const procedure = get(contract, path);
|
|
285
|
+
if (!isContractProcedure(procedure)) {
|
|
286
|
+
throw new Error(
|
|
287
|
+
`[inferRPCMethodFromContractRouter] No valid procedure found at path "${path.join(".")}". This may happen when the contract router is not properly configured.`
|
|
288
|
+
);
|
|
289
|
+
}
|
|
290
|
+
const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
|
|
291
|
+
return method === "HEAD" ? "GET" : method;
|
|
292
|
+
};
|
|
223
293
|
}
|
|
224
294
|
|
|
225
295
|
function type(...[map]) {
|
|
@@ -237,4 +307,19 @@ function type(...[map]) {
|
|
|
237
307
|
};
|
|
238
308
|
}
|
|
239
309
|
|
|
240
|
-
|
|
310
|
+
function isSchemaIssue(issue) {
|
|
311
|
+
if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
|
|
312
|
+
return false;
|
|
313
|
+
}
|
|
314
|
+
if (issue.path !== void 0) {
|
|
315
|
+
if (!Array.isArray(issue.path)) {
|
|
316
|
+
return false;
|
|
317
|
+
}
|
|
318
|
+
if (!issue.path.every((segment) => isPropertyKey(segment) || isTypescriptObject(segment) && isPropertyKey(segment.key))) {
|
|
319
|
+
return false;
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
return true;
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, inferRPCMethodFromContractRouter, isContractProcedure, isSchemaIssue, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, minifyContractRouter, oc, prefixRoute, type, unshiftTagRoute };
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ClientContext } from '@orpc/client';
|
|
2
|
+
import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
|
|
3
|
+
import { A as AnyContractRouter } from '../shared/contract.CvRxURhn.mjs';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import '@standard-schema/spec';
|
|
6
|
+
import 'openapi-types';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* A link plugin that validates server responses against your contract schema,
|
|
10
|
+
* ensuring that data returned from your server matches the expected types defined in your contract.
|
|
11
|
+
*
|
|
12
|
+
* - Throws `ValidationError` if output doesn't match the expected schema
|
|
13
|
+
* - Converts mismatched defined errors to normal `ORPCError` instances
|
|
14
|
+
*
|
|
15
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-validation Response Validation Plugin Docs}
|
|
16
|
+
*/
|
|
17
|
+
declare class ResponseValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
18
|
+
private readonly contract;
|
|
19
|
+
constructor(contract: AnyContractRouter);
|
|
20
|
+
order: number;
|
|
21
|
+
init(options: StandardLinkOptions<T>): void;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export { ResponseValidationPlugin };
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ClientContext } from '@orpc/client';
|
|
2
|
+
import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
|
|
3
|
+
import { A as AnyContractRouter } from '../shared/contract.CvRxURhn.js';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import '@standard-schema/spec';
|
|
6
|
+
import 'openapi-types';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* A link plugin that validates server responses against your contract schema,
|
|
10
|
+
* ensuring that data returned from your server matches the expected types defined in your contract.
|
|
11
|
+
*
|
|
12
|
+
* - Throws `ValidationError` if output doesn't match the expected schema
|
|
13
|
+
* - Converts mismatched defined errors to normal `ORPCError` instances
|
|
14
|
+
*
|
|
15
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-validation Response Validation Plugin Docs}
|
|
16
|
+
*/
|
|
17
|
+
declare class ResponseValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
18
|
+
private readonly contract;
|
|
19
|
+
constructor(contract: AnyContractRouter);
|
|
20
|
+
order: number;
|
|
21
|
+
init(options: StandardLinkOptions<T>): void;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export { ResponseValidationPlugin };
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { ORPCError } from '@orpc/client';
|
|
2
|
+
import { get } from '@orpc/shared';
|
|
3
|
+
import { i as isContractProcedure, V as ValidationError, v as validateORPCError } from '../shared/contract.D_dZrO__.mjs';
|
|
4
|
+
|
|
5
|
+
class ResponseValidationPlugin {
|
|
6
|
+
constructor(contract) {
|
|
7
|
+
this.contract = contract;
|
|
8
|
+
}
|
|
9
|
+
order = 15e5;
|
|
10
|
+
// make sure run before DurableEventIteratorLinkPlugin
|
|
11
|
+
init(options) {
|
|
12
|
+
options.interceptors ??= [];
|
|
13
|
+
options.interceptors.push(async ({ next, path }) => {
|
|
14
|
+
const procedure = get(this.contract, path);
|
|
15
|
+
if (!isContractProcedure(procedure)) {
|
|
16
|
+
throw new Error(`[ResponseValidationPlugin] no valid procedure found at path "${path.join(".")}", this may happen when the contract router is not properly configured.`);
|
|
17
|
+
}
|
|
18
|
+
try {
|
|
19
|
+
const output = await next();
|
|
20
|
+
const outputSchema = procedure["~orpc"].outputSchema;
|
|
21
|
+
if (!outputSchema) {
|
|
22
|
+
return output;
|
|
23
|
+
}
|
|
24
|
+
const result = await outputSchema["~standard"].validate(output);
|
|
25
|
+
if (result.issues) {
|
|
26
|
+
throw new ValidationError({
|
|
27
|
+
message: "Server response output does not match expected schema",
|
|
28
|
+
issues: result.issues,
|
|
29
|
+
data: output
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
return result.value;
|
|
33
|
+
} catch (e) {
|
|
34
|
+
if (e instanceof ORPCError) {
|
|
35
|
+
throw await validateORPCError(procedure["~orpc"].errorMap, e);
|
|
36
|
+
}
|
|
37
|
+
throw e;
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export { ResponseValidationPlugin };
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
import { ORPCErrorCode, ORPCError, HTTPMethod, HTTPPath } from '@orpc/client';
|
|
2
|
+
import { Promisable, IsEqual, ThrowableError } from '@orpc/shared';
|
|
3
|
+
import { StandardSchemaV1 } from '@standard-schema/spec';
|
|
4
|
+
import { OpenAPIV3_1 } from 'openapi-types';
|
|
5
|
+
|
|
6
|
+
type Schema<TInput, TOutput> = StandardSchemaV1<TInput, TOutput>;
|
|
7
|
+
type AnySchema = Schema<any, any>;
|
|
8
|
+
type SchemaIssue = StandardSchemaV1.Issue;
|
|
9
|
+
type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
|
|
10
|
+
type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
|
|
11
|
+
type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
|
|
12
|
+
/**
|
|
13
|
+
* The schema for things can be trust without validation.
|
|
14
|
+
* If the TInput and TOutput are different, you need pass a map function.
|
|
15
|
+
*
|
|
16
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure#type-utility Type Utility Docs}
|
|
17
|
+
*/
|
|
18
|
+
declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
|
|
19
|
+
|
|
20
|
+
interface ValidationErrorOptions extends ErrorOptions {
|
|
21
|
+
message: string;
|
|
22
|
+
issues: readonly SchemaIssue[];
|
|
23
|
+
/**
|
|
24
|
+
* @todo require this field in v2
|
|
25
|
+
*/
|
|
26
|
+
data?: unknown;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* This errors usually used for ORPCError.cause when the error is a validation error.
|
|
30
|
+
*
|
|
31
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
|
|
32
|
+
*/
|
|
33
|
+
declare class ValidationError extends Error {
|
|
34
|
+
readonly issues: readonly SchemaIssue[];
|
|
35
|
+
readonly data: unknown;
|
|
36
|
+
constructor(options: ValidationErrorOptions);
|
|
37
|
+
}
|
|
38
|
+
interface ErrorMapItem<TDataSchema extends AnySchema> {
|
|
39
|
+
status?: number;
|
|
40
|
+
message?: string;
|
|
41
|
+
data?: TDataSchema;
|
|
42
|
+
}
|
|
43
|
+
type ErrorMap = {
|
|
44
|
+
[key in ORPCErrorCode]?: ErrorMapItem<AnySchema>;
|
|
45
|
+
};
|
|
46
|
+
type MergedErrorMap<T1 extends ErrorMap, T2 extends ErrorMap> = Omit<T1, keyof T2> & T2;
|
|
47
|
+
declare function mergeErrorMap<T1 extends ErrorMap, T2 extends ErrorMap>(errorMap1: T1, errorMap2: T2): MergedErrorMap<T1, T2>;
|
|
48
|
+
type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
|
|
49
|
+
[K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema extends Schema<unknown, unknown>> ? ORPCError<K, InferSchemaOutput<TDataSchema>> : never : never;
|
|
50
|
+
}[keyof TErrorMap];
|
|
51
|
+
type ErrorFromErrorMap<TErrorMap extends ErrorMap> = ORPCErrorFromErrorMap<TErrorMap> | ThrowableError;
|
|
52
|
+
declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
|
|
53
|
+
|
|
54
|
+
type Meta = Record<string, any>;
|
|
55
|
+
declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
|
|
56
|
+
|
|
57
|
+
type InputStructure = 'compact' | 'detailed';
|
|
58
|
+
type OutputStructure = 'compact' | 'detailed';
|
|
59
|
+
interface Route {
|
|
60
|
+
/**
|
|
61
|
+
* The HTTP method of the procedure.
|
|
62
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
63
|
+
*
|
|
64
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
65
|
+
*/
|
|
66
|
+
method?: HTTPMethod;
|
|
67
|
+
/**
|
|
68
|
+
* The HTTP path of the procedure.
|
|
69
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
70
|
+
*
|
|
71
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
72
|
+
*/
|
|
73
|
+
path?: HTTPPath;
|
|
74
|
+
/**
|
|
75
|
+
* The operation ID of the endpoint.
|
|
76
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
77
|
+
*
|
|
78
|
+
* @default Concatenation of router segments
|
|
79
|
+
*/
|
|
80
|
+
operationId?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The summary of the procedure.
|
|
83
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
84
|
+
*
|
|
85
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
86
|
+
*/
|
|
87
|
+
summary?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The description of the procedure.
|
|
90
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
91
|
+
*
|
|
92
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
93
|
+
*/
|
|
94
|
+
description?: string;
|
|
95
|
+
/**
|
|
96
|
+
* Marks the procedure as deprecated.
|
|
97
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
98
|
+
*
|
|
99
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
100
|
+
*/
|
|
101
|
+
deprecated?: boolean;
|
|
102
|
+
/**
|
|
103
|
+
* The tags of the procedure.
|
|
104
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
107
|
+
*/
|
|
108
|
+
tags?: readonly string[];
|
|
109
|
+
/**
|
|
110
|
+
* The status code of the response when the procedure is successful.
|
|
111
|
+
* The status code must be in the 200-399 range.
|
|
112
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
113
|
+
*
|
|
114
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
|
|
115
|
+
* @default 200
|
|
116
|
+
*/
|
|
117
|
+
successStatus?: number;
|
|
118
|
+
/**
|
|
119
|
+
* The description of the response when the procedure is successful.
|
|
120
|
+
* This option is typically relevant when integrating with OpenAPI.
|
|
121
|
+
*
|
|
122
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
|
|
123
|
+
* @default 'OK'
|
|
124
|
+
*/
|
|
125
|
+
successDescription?: string;
|
|
126
|
+
/**
|
|
127
|
+
* Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
|
|
128
|
+
*
|
|
129
|
+
* @option 'compact'
|
|
130
|
+
* Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
|
|
131
|
+
*
|
|
132
|
+
* @option 'detailed'
|
|
133
|
+
* Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
|
|
134
|
+
*
|
|
135
|
+
* Example:
|
|
136
|
+
* ```ts
|
|
137
|
+
* const input = {
|
|
138
|
+
* params: { id: 1 },
|
|
139
|
+
* query: { search: 'hello' },
|
|
140
|
+
* headers: { 'Content-Type': 'application/json' },
|
|
141
|
+
* body: { name: 'John' },
|
|
142
|
+
* }
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
145
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
146
|
+
* @default 'compact'
|
|
147
|
+
*/
|
|
148
|
+
inputStructure?: InputStructure;
|
|
149
|
+
/**
|
|
150
|
+
* Determines how the response should be structured based on the output.
|
|
151
|
+
*
|
|
152
|
+
* @option 'compact'
|
|
153
|
+
* The output data is directly returned as the response body.
|
|
154
|
+
*
|
|
155
|
+
* @option 'detailed'
|
|
156
|
+
* Return an object with optional properties:
|
|
157
|
+
* - `status`: The response status (must be in 200-399 range) if not set fallback to `successStatus`.
|
|
158
|
+
* - `headers`: Custom headers to merge with the response headers (`Record<string, string | string[] | undefined>`)
|
|
159
|
+
* - `body`: The response body.
|
|
160
|
+
*
|
|
161
|
+
* Example:
|
|
162
|
+
* ```ts
|
|
163
|
+
* const output = {
|
|
164
|
+
* status: 201,
|
|
165
|
+
* headers: { 'x-custom-header': 'value' },
|
|
166
|
+
* body: { message: 'Hello, world!' },
|
|
167
|
+
* };
|
|
168
|
+
* ```
|
|
169
|
+
*
|
|
170
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
|
|
171
|
+
* @default 'compact'
|
|
172
|
+
*/
|
|
173
|
+
outputStructure?: OutputStructure;
|
|
174
|
+
/**
|
|
175
|
+
* Override entire auto-generated OpenAPI Operation Object Specification.
|
|
176
|
+
*
|
|
177
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata Operation Metadata Docs}
|
|
178
|
+
*/
|
|
179
|
+
spec?: OpenAPIV3_1.OperationObject | ((current: OpenAPIV3_1.OperationObject) => OpenAPIV3_1.OperationObject);
|
|
180
|
+
}
|
|
181
|
+
declare function mergeRoute(a: Route, b: Route): Route;
|
|
182
|
+
declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
|
|
183
|
+
declare function unshiftTagRoute(route: Route, tags: readonly string[]): Route;
|
|
184
|
+
declare function mergePrefix(a: HTTPPath | undefined, b: HTTPPath): HTTPPath;
|
|
185
|
+
declare function mergeTags(a: readonly string[] | undefined, b: readonly string[]): readonly string[];
|
|
186
|
+
interface EnhanceRouteOptions {
|
|
187
|
+
prefix?: HTTPPath;
|
|
188
|
+
tags?: readonly string[];
|
|
189
|
+
}
|
|
190
|
+
declare function enhanceRoute(route: Route, options: EnhanceRouteOptions): Route;
|
|
191
|
+
|
|
192
|
+
interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
193
|
+
meta: TMeta;
|
|
194
|
+
route: Route;
|
|
195
|
+
inputSchema?: TInputSchema;
|
|
196
|
+
outputSchema?: TOutputSchema;
|
|
197
|
+
errorMap: TErrorMap;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* This class represents a contract procedure.
|
|
201
|
+
*
|
|
202
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract Contract Procedure Docs}
|
|
203
|
+
*/
|
|
204
|
+
declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
205
|
+
/**
|
|
206
|
+
* This property holds the defined options for the contract procedure.
|
|
207
|
+
*/
|
|
208
|
+
'~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
209
|
+
constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
210
|
+
}
|
|
211
|
+
type AnyContractProcedure = ContractProcedure<any, any, any, any>;
|
|
212
|
+
declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Represents a contract router, which defines a hierarchical structure of contract procedures.
|
|
216
|
+
*
|
|
217
|
+
* @info A contract procedure is a contract router too.
|
|
218
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
|
|
219
|
+
*/
|
|
220
|
+
type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
|
|
221
|
+
[k: string]: ContractRouter<TMeta>;
|
|
222
|
+
};
|
|
223
|
+
type AnyContractRouter = ContractRouter<any>;
|
|
224
|
+
/**
|
|
225
|
+
* Infer all inputs of the contract router.
|
|
226
|
+
*
|
|
227
|
+
* @info A contract procedure is a contract router too.
|
|
228
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
|
|
229
|
+
*/
|
|
230
|
+
type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
231
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Infer all outputs of the contract router.
|
|
235
|
+
*
|
|
236
|
+
* @info A contract procedure is a contract router too.
|
|
237
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
|
|
238
|
+
*/
|
|
239
|
+
type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
240
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* Infer all errors of the contract router.
|
|
244
|
+
*
|
|
245
|
+
* @info A contract procedure is a contract router too.
|
|
246
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
|
|
247
|
+
*/
|
|
248
|
+
type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
|
|
249
|
+
[K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
|
|
250
|
+
}[keyof T];
|
|
251
|
+
type InferContractRouterMeta<T extends AnyContractRouter> = T extends ContractRouter<infer UMeta> ? UMeta : never;
|
|
252
|
+
|
|
253
|
+
export { ContractProcedure as C, type as D, ValidationError as j, mergeErrorMap as m, mergeMeta as n, isContractProcedure as p, mergeRoute as q, prefixRoute as r, mergePrefix as s, mergeTags as t, unshiftTagRoute as u, validateORPCError as v, enhanceRoute as w };
|
|
254
|
+
export type { AnyContractRouter as A, InferContractRouterMeta as B, ErrorMap as E, InputStructure as I, MergedErrorMap as M, OutputStructure as O, Route as R, Schema as S, TypeRest as T, ValidationErrorOptions as V, EnhanceRouteOptions as a, AnySchema as b, Meta as c, ContractRouter as d, ContractProcedureDef as e, InferSchemaInput as f, InferSchemaOutput as g, ErrorFromErrorMap as h, SchemaIssue as i, ErrorMapItem as k, ORPCErrorFromErrorMap as l, AnyContractProcedure as o, InferContractRouterInputs as x, InferContractRouterOutputs as y, InferContractRouterErrorMap as z };
|