@orpc/contract 0.0.0-next.f22c7ec → 0.0.0-next.f437dcb
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 +111 -0
- package/dist/index.d.mts +552 -0
- package/dist/index.d.ts +552 -0
- package/dist/index.mjs +358 -0
- package/package.json +12 -15
- package/dist/index.js +0 -406
- package/dist/src/builder.d.ts +0 -23
- package/dist/src/client-utils.d.ts +0 -5
- package/dist/src/client.d.ts +0 -19
- package/dist/src/config.d.ts +0 -36
- package/dist/src/error-map.d.ts +0 -58
- package/dist/src/error-orpc.d.ts +0 -109
- package/dist/src/error.d.ts +0 -13
- package/dist/src/index.d.ts +0 -18
- package/dist/src/procedure-client.d.ts +0 -6
- package/dist/src/procedure-decorated.d.ts +0 -14
- package/dist/src/procedure.d.ts +0 -83
- package/dist/src/router-builder.d.ts +0 -23
- package/dist/src/router-client.d.ts +0 -7
- package/dist/src/router.d.ts +0 -13
- package/dist/src/types.d.ts +0 -11
package/dist/index.js
DELETED
|
@@ -1,406 +0,0 @@
|
|
|
1
|
-
// src/procedure.ts
|
|
2
|
-
var ContractProcedure = class {
|
|
3
|
-
"~type" = "ContractProcedure";
|
|
4
|
-
"~orpc";
|
|
5
|
-
constructor(def) {
|
|
6
|
-
if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
|
|
7
|
-
throw new Error("[ContractProcedure] The successStatus must be between 200 and 299");
|
|
8
|
-
}
|
|
9
|
-
if (Object.values(def.errorMap ?? {}).some((val) => val && val.status && (val.status < 400 || val.status > 599))) {
|
|
10
|
-
throw new Error("[ContractProcedure] The error status code must be in the 400-599 range.");
|
|
11
|
-
}
|
|
12
|
-
this["~orpc"] = def;
|
|
13
|
-
}
|
|
14
|
-
};
|
|
15
|
-
function isContractProcedure(item) {
|
|
16
|
-
if (item instanceof ContractProcedure) {
|
|
17
|
-
return true;
|
|
18
|
-
}
|
|
19
|
-
return (typeof item === "object" || typeof item === "function") && item !== null && "~type" in item && item["~type"] === "ContractProcedure" && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "InputSchema" in item["~orpc"] && "OutputSchema" in item["~orpc"] && "errorMap" in item["~orpc"];
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
// src/procedure-decorated.ts
|
|
23
|
-
var DecoratedContractProcedure = class _DecoratedContractProcedure extends ContractProcedure {
|
|
24
|
-
static decorate(procedure) {
|
|
25
|
-
if (procedure instanceof _DecoratedContractProcedure) {
|
|
26
|
-
return procedure;
|
|
27
|
-
}
|
|
28
|
-
return new _DecoratedContractProcedure(procedure["~orpc"]);
|
|
29
|
-
}
|
|
30
|
-
route(route) {
|
|
31
|
-
return new _DecoratedContractProcedure({
|
|
32
|
-
...this["~orpc"],
|
|
33
|
-
route: {
|
|
34
|
-
...this["~orpc"].route,
|
|
35
|
-
...route
|
|
36
|
-
}
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
prefix(prefix) {
|
|
40
|
-
return new _DecoratedContractProcedure({
|
|
41
|
-
...this["~orpc"],
|
|
42
|
-
...this["~orpc"].route?.path ? {
|
|
43
|
-
route: {
|
|
44
|
-
...this["~orpc"].route,
|
|
45
|
-
path: `${prefix}${this["~orpc"].route.path}`
|
|
46
|
-
}
|
|
47
|
-
} : void 0
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
unshiftTag(...tags) {
|
|
51
|
-
return new _DecoratedContractProcedure({
|
|
52
|
-
...this["~orpc"],
|
|
53
|
-
route: {
|
|
54
|
-
...this["~orpc"].route,
|
|
55
|
-
tags: [
|
|
56
|
-
...tags,
|
|
57
|
-
...this["~orpc"].route?.tags?.filter((tag) => !tags.includes(tag)) ?? []
|
|
58
|
-
]
|
|
59
|
-
}
|
|
60
|
-
});
|
|
61
|
-
}
|
|
62
|
-
input(schema, example) {
|
|
63
|
-
return new _DecoratedContractProcedure({
|
|
64
|
-
...this["~orpc"],
|
|
65
|
-
InputSchema: schema,
|
|
66
|
-
inputExample: example
|
|
67
|
-
});
|
|
68
|
-
}
|
|
69
|
-
output(schema, example) {
|
|
70
|
-
return new _DecoratedContractProcedure({
|
|
71
|
-
...this["~orpc"],
|
|
72
|
-
OutputSchema: schema,
|
|
73
|
-
outputExample: example
|
|
74
|
-
});
|
|
75
|
-
}
|
|
76
|
-
errors(errors) {
|
|
77
|
-
return new _DecoratedContractProcedure({
|
|
78
|
-
...this["~orpc"],
|
|
79
|
-
errorMap: {
|
|
80
|
-
...this["~orpc"].errorMap,
|
|
81
|
-
...errors
|
|
82
|
-
}
|
|
83
|
-
});
|
|
84
|
-
}
|
|
85
|
-
};
|
|
86
|
-
|
|
87
|
-
// src/router-builder.ts
|
|
88
|
-
var ContractRouterBuilder = class _ContractRouterBuilder {
|
|
89
|
-
"~type" = "ContractProcedure";
|
|
90
|
-
"~orpc";
|
|
91
|
-
constructor(def) {
|
|
92
|
-
this["~orpc"] = def;
|
|
93
|
-
}
|
|
94
|
-
prefix(prefix) {
|
|
95
|
-
return new _ContractRouterBuilder({
|
|
96
|
-
...this["~orpc"],
|
|
97
|
-
prefix: `${this["~orpc"].prefix ?? ""}${prefix}`
|
|
98
|
-
});
|
|
99
|
-
}
|
|
100
|
-
tag(...tags) {
|
|
101
|
-
return new _ContractRouterBuilder({
|
|
102
|
-
...this["~orpc"],
|
|
103
|
-
tags: [...this["~orpc"].tags ?? [], ...tags]
|
|
104
|
-
});
|
|
105
|
-
}
|
|
106
|
-
errors(errors) {
|
|
107
|
-
return new _ContractRouterBuilder({
|
|
108
|
-
...this["~orpc"],
|
|
109
|
-
errorMap: {
|
|
110
|
-
...this["~orpc"].errorMap,
|
|
111
|
-
...errors
|
|
112
|
-
}
|
|
113
|
-
});
|
|
114
|
-
}
|
|
115
|
-
router(router) {
|
|
116
|
-
if (isContractProcedure(router)) {
|
|
117
|
-
let decorated = DecoratedContractProcedure.decorate(router);
|
|
118
|
-
if (this["~orpc"].tags) {
|
|
119
|
-
decorated = decorated.unshiftTag(...this["~orpc"].tags);
|
|
120
|
-
}
|
|
121
|
-
if (this["~orpc"].prefix) {
|
|
122
|
-
decorated = decorated.prefix(this["~orpc"].prefix);
|
|
123
|
-
}
|
|
124
|
-
decorated = decorated.errors(this["~orpc"].errorMap);
|
|
125
|
-
return decorated;
|
|
126
|
-
}
|
|
127
|
-
const adapted = {};
|
|
128
|
-
for (const key in router) {
|
|
129
|
-
adapted[key] = this.router(router[key]);
|
|
130
|
-
}
|
|
131
|
-
return adapted;
|
|
132
|
-
}
|
|
133
|
-
};
|
|
134
|
-
|
|
135
|
-
// src/builder.ts
|
|
136
|
-
var ContractBuilder = class _ContractBuilder {
|
|
137
|
-
"~type" = "ContractBuilder";
|
|
138
|
-
"~orpc";
|
|
139
|
-
constructor(def) {
|
|
140
|
-
this["~orpc"] = def;
|
|
141
|
-
}
|
|
142
|
-
errors(errors) {
|
|
143
|
-
return new _ContractBuilder({
|
|
144
|
-
...this["~orpc"],
|
|
145
|
-
errorMap: {
|
|
146
|
-
...this["~orpc"].errorMap,
|
|
147
|
-
...errors
|
|
148
|
-
}
|
|
149
|
-
});
|
|
150
|
-
}
|
|
151
|
-
prefix(prefix) {
|
|
152
|
-
return new ContractRouterBuilder({
|
|
153
|
-
prefix,
|
|
154
|
-
errorMap: this["~orpc"].errorMap
|
|
155
|
-
});
|
|
156
|
-
}
|
|
157
|
-
tag(...tags) {
|
|
158
|
-
return new ContractRouterBuilder({
|
|
159
|
-
tags,
|
|
160
|
-
errorMap: this["~orpc"].errorMap
|
|
161
|
-
});
|
|
162
|
-
}
|
|
163
|
-
route(route) {
|
|
164
|
-
return new DecoratedContractProcedure({
|
|
165
|
-
route,
|
|
166
|
-
InputSchema: void 0,
|
|
167
|
-
OutputSchema: void 0,
|
|
168
|
-
errorMap: this["~orpc"].errorMap
|
|
169
|
-
});
|
|
170
|
-
}
|
|
171
|
-
input(schema, example) {
|
|
172
|
-
return new DecoratedContractProcedure({
|
|
173
|
-
InputSchema: schema,
|
|
174
|
-
inputExample: example,
|
|
175
|
-
OutputSchema: void 0,
|
|
176
|
-
errorMap: this["~orpc"].errorMap
|
|
177
|
-
});
|
|
178
|
-
}
|
|
179
|
-
output(schema, example) {
|
|
180
|
-
return new DecoratedContractProcedure({
|
|
181
|
-
OutputSchema: schema,
|
|
182
|
-
outputExample: example,
|
|
183
|
-
InputSchema: void 0,
|
|
184
|
-
errorMap: this["~orpc"].errorMap
|
|
185
|
-
});
|
|
186
|
-
}
|
|
187
|
-
router(router) {
|
|
188
|
-
return new ContractRouterBuilder({
|
|
189
|
-
errorMap: this["~orpc"].errorMap
|
|
190
|
-
}).router(router);
|
|
191
|
-
}
|
|
192
|
-
};
|
|
193
|
-
|
|
194
|
-
// src/error-orpc.ts
|
|
195
|
-
import { isPlainObject } from "@orpc/shared";
|
|
196
|
-
var COMMON_ORPC_ERROR_DEFS = {
|
|
197
|
-
BAD_REQUEST: {
|
|
198
|
-
status: 400,
|
|
199
|
-
message: "Bad Request"
|
|
200
|
-
},
|
|
201
|
-
UNAUTHORIZED: {
|
|
202
|
-
status: 401,
|
|
203
|
-
message: "Unauthorized"
|
|
204
|
-
},
|
|
205
|
-
FORBIDDEN: {
|
|
206
|
-
status: 403,
|
|
207
|
-
message: "Forbidden"
|
|
208
|
-
},
|
|
209
|
-
NOT_FOUND: {
|
|
210
|
-
status: 404,
|
|
211
|
-
message: "Not Found"
|
|
212
|
-
},
|
|
213
|
-
METHOD_NOT_SUPPORTED: {
|
|
214
|
-
status: 405,
|
|
215
|
-
message: "Method Not Supported"
|
|
216
|
-
},
|
|
217
|
-
NOT_ACCEPTABLE: {
|
|
218
|
-
status: 406,
|
|
219
|
-
message: "Not Acceptable"
|
|
220
|
-
},
|
|
221
|
-
TIMEOUT: {
|
|
222
|
-
status: 408,
|
|
223
|
-
message: "Request Timeout"
|
|
224
|
-
},
|
|
225
|
-
CONFLICT: {
|
|
226
|
-
status: 409,
|
|
227
|
-
message: "Conflict"
|
|
228
|
-
},
|
|
229
|
-
PRECONDITION_FAILED: {
|
|
230
|
-
status: 412,
|
|
231
|
-
message: "Precondition Failed"
|
|
232
|
-
},
|
|
233
|
-
PAYLOAD_TOO_LARGE: {
|
|
234
|
-
status: 413,
|
|
235
|
-
message: "Payload Too Large"
|
|
236
|
-
},
|
|
237
|
-
UNSUPPORTED_MEDIA_TYPE: {
|
|
238
|
-
status: 415,
|
|
239
|
-
message: "Unsupported Media Type"
|
|
240
|
-
},
|
|
241
|
-
UNPROCESSABLE_CONTENT: {
|
|
242
|
-
status: 422,
|
|
243
|
-
message: "Unprocessable Content"
|
|
244
|
-
},
|
|
245
|
-
TOO_MANY_REQUESTS: {
|
|
246
|
-
status: 429,
|
|
247
|
-
message: "Too Many Requests"
|
|
248
|
-
},
|
|
249
|
-
CLIENT_CLOSED_REQUEST: {
|
|
250
|
-
status: 499,
|
|
251
|
-
message: "Client Closed Request"
|
|
252
|
-
},
|
|
253
|
-
INTERNAL_SERVER_ERROR: {
|
|
254
|
-
status: 500,
|
|
255
|
-
message: "Internal Server Error"
|
|
256
|
-
},
|
|
257
|
-
NOT_IMPLEMENTED: {
|
|
258
|
-
status: 501,
|
|
259
|
-
message: "Not Implemented"
|
|
260
|
-
},
|
|
261
|
-
BAD_GATEWAY: {
|
|
262
|
-
status: 502,
|
|
263
|
-
message: "Bad Gateway"
|
|
264
|
-
},
|
|
265
|
-
SERVICE_UNAVAILABLE: {
|
|
266
|
-
status: 503,
|
|
267
|
-
message: "Service Unavailable"
|
|
268
|
-
},
|
|
269
|
-
GATEWAY_TIMEOUT: {
|
|
270
|
-
status: 504,
|
|
271
|
-
message: "Gateway Timeout"
|
|
272
|
-
}
|
|
273
|
-
};
|
|
274
|
-
function fallbackORPCErrorStatus(code, status) {
|
|
275
|
-
return status ?? COMMON_ORPC_ERROR_DEFS[code]?.status ?? 500;
|
|
276
|
-
}
|
|
277
|
-
function fallbackORPCErrorMessage(code, message) {
|
|
278
|
-
return message || COMMON_ORPC_ERROR_DEFS[code]?.message || code;
|
|
279
|
-
}
|
|
280
|
-
var ORPCError = class extends Error {
|
|
281
|
-
defined;
|
|
282
|
-
code;
|
|
283
|
-
status;
|
|
284
|
-
data;
|
|
285
|
-
constructor(options) {
|
|
286
|
-
if (options.status && (options.status < 400 || options.status >= 600)) {
|
|
287
|
-
throw new Error("[ORPCError] The error status code must be in the 400-599 range.");
|
|
288
|
-
}
|
|
289
|
-
const message = fallbackORPCErrorMessage(options.code, options.message);
|
|
290
|
-
super(message, options);
|
|
291
|
-
this.code = options.code;
|
|
292
|
-
this.status = fallbackORPCErrorStatus(options.code, options.status);
|
|
293
|
-
this.defined = options.defined ?? false;
|
|
294
|
-
this.data = options.data;
|
|
295
|
-
}
|
|
296
|
-
toJSON() {
|
|
297
|
-
return {
|
|
298
|
-
defined: this.defined,
|
|
299
|
-
code: this.code,
|
|
300
|
-
status: this.status,
|
|
301
|
-
message: this.message,
|
|
302
|
-
data: this.data
|
|
303
|
-
};
|
|
304
|
-
}
|
|
305
|
-
static isValidJSON(json) {
|
|
306
|
-
return isPlainObject(json) && "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && "message" in json && typeof json.message === "string";
|
|
307
|
-
}
|
|
308
|
-
};
|
|
309
|
-
function isDefinedError(error) {
|
|
310
|
-
return error instanceof ORPCError && error.defined;
|
|
311
|
-
}
|
|
312
|
-
async function validateORPCError(map, error) {
|
|
313
|
-
const { code, status, message, data, cause, defined } = error;
|
|
314
|
-
const config = map?.[error.code];
|
|
315
|
-
if (!config || fallbackORPCErrorStatus(error.code, config.status) !== error.status) {
|
|
316
|
-
return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
|
|
317
|
-
}
|
|
318
|
-
if (!config.data) {
|
|
319
|
-
return defined ? error : new ORPCError({ defined: true, code, status, message, data, cause });
|
|
320
|
-
}
|
|
321
|
-
const validated = await config.data["~standard"].validate(error.data);
|
|
322
|
-
if (validated.issues) {
|
|
323
|
-
return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
|
|
324
|
-
}
|
|
325
|
-
return new ORPCError({
|
|
326
|
-
defined: true,
|
|
327
|
-
code,
|
|
328
|
-
status,
|
|
329
|
-
message,
|
|
330
|
-
data: validated.value,
|
|
331
|
-
cause
|
|
332
|
-
});
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
// src/client-utils.ts
|
|
336
|
-
async function safe(promise) {
|
|
337
|
-
try {
|
|
338
|
-
const output = await promise;
|
|
339
|
-
return [output, void 0, false];
|
|
340
|
-
} catch (e) {
|
|
341
|
-
const error = e;
|
|
342
|
-
if (isDefinedError(error)) {
|
|
343
|
-
return [void 0, error, true];
|
|
344
|
-
}
|
|
345
|
-
return [void 0, error, false];
|
|
346
|
-
}
|
|
347
|
-
}
|
|
348
|
-
|
|
349
|
-
// src/config.ts
|
|
350
|
-
var DEFAULT_CONFIG = {
|
|
351
|
-
defaultMethod: "POST",
|
|
352
|
-
defaultSuccessStatus: 200,
|
|
353
|
-
defaultSuccessDescription: "OK",
|
|
354
|
-
defaultInputStructure: "compact",
|
|
355
|
-
defaultOutputStructure: "compact"
|
|
356
|
-
};
|
|
357
|
-
var GLOBAL_CONFIG_REF = { value: DEFAULT_CONFIG };
|
|
358
|
-
function configGlobal(config) {
|
|
359
|
-
if (config.defaultSuccessStatus !== void 0 && (config.defaultSuccessStatus < 200 || config.defaultSuccessStatus > 299)) {
|
|
360
|
-
throw new Error("[configGlobal] The defaultSuccessStatus must be between 200 and 299");
|
|
361
|
-
}
|
|
362
|
-
GLOBAL_CONFIG_REF.value = config;
|
|
363
|
-
}
|
|
364
|
-
function fallbackToGlobalConfig(key, value) {
|
|
365
|
-
if (value === void 0) {
|
|
366
|
-
const fallback = GLOBAL_CONFIG_REF.value[key];
|
|
367
|
-
if (fallback === void 0) {
|
|
368
|
-
return DEFAULT_CONFIG[key];
|
|
369
|
-
}
|
|
370
|
-
return fallback;
|
|
371
|
-
}
|
|
372
|
-
return value;
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
// src/error.ts
|
|
376
|
-
var ValidationError = class extends Error {
|
|
377
|
-
issues;
|
|
378
|
-
constructor(options) {
|
|
379
|
-
super(options.message, options);
|
|
380
|
-
this.issues = options.issues;
|
|
381
|
-
}
|
|
382
|
-
};
|
|
383
|
-
|
|
384
|
-
// src/index.ts
|
|
385
|
-
var oc = new ContractBuilder({
|
|
386
|
-
errorMap: {}
|
|
387
|
-
});
|
|
388
|
-
export {
|
|
389
|
-
COMMON_ORPC_ERROR_DEFS,
|
|
390
|
-
ContractBuilder,
|
|
391
|
-
ContractProcedure,
|
|
392
|
-
ContractRouterBuilder,
|
|
393
|
-
DecoratedContractProcedure,
|
|
394
|
-
ORPCError,
|
|
395
|
-
ValidationError,
|
|
396
|
-
configGlobal,
|
|
397
|
-
fallbackORPCErrorMessage,
|
|
398
|
-
fallbackORPCErrorStatus,
|
|
399
|
-
fallbackToGlobalConfig,
|
|
400
|
-
isContractProcedure,
|
|
401
|
-
isDefinedError,
|
|
402
|
-
oc,
|
|
403
|
-
safe,
|
|
404
|
-
validateORPCError
|
|
405
|
-
};
|
|
406
|
-
//# sourceMappingURL=index.js.map
|
package/dist/src/builder.d.ts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap, ErrorMapGuard, ErrorMapSuggestions, StrictErrorMap } from './error-map';
|
|
2
|
-
import type { RouteOptions } from './procedure';
|
|
3
|
-
import type { ContractRouter } from './router';
|
|
4
|
-
import type { AdaptedContractRouter } from './router-builder';
|
|
5
|
-
import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
|
|
6
|
-
import { DecoratedContractProcedure } from './procedure-decorated';
|
|
7
|
-
import { ContractRouterBuilder } from './router-builder';
|
|
8
|
-
export type ContractBuilderDef<TErrorMap extends ErrorMap> = {
|
|
9
|
-
errorMap: TErrorMap;
|
|
10
|
-
};
|
|
11
|
-
export declare class ContractBuilder<TErrorMap extends ErrorMap> {
|
|
12
|
-
'~type': "ContractBuilder";
|
|
13
|
-
'~orpc': ContractBuilderDef<TErrorMap>;
|
|
14
|
-
constructor(def: ContractBuilderDef<TErrorMap>);
|
|
15
|
-
errors<const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions>(errors: U): ContractBuilder<U & TErrorMap>;
|
|
16
|
-
prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap>;
|
|
17
|
-
tag(...tags: string[]): ContractRouterBuilder<TErrorMap>;
|
|
18
|
-
route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined, TErrorMap>;
|
|
19
|
-
input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined, TErrorMap>;
|
|
20
|
-
output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U, TErrorMap>;
|
|
21
|
-
router<T extends ContractRouter<ErrorMap & Partial<StrictErrorMap<TErrorMap>>>>(router: T): AdaptedContractRouter<T, TErrorMap>;
|
|
22
|
-
}
|
|
23
|
-
//# sourceMappingURL=builder.d.ts.map
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import type { ClientPromiseResult } from './client';
|
|
2
|
-
import { type ORPCError } from './error-orpc';
|
|
3
|
-
export type SafeResult<TOutput, TError extends Error> = [output: TOutput, error: undefined, isDefinedError: false] | [output: undefined, error: TError, isDefinedError: false] | [output: undefined, error: Extract<TError, ORPCError<any, any>>, isDefinedError: true];
|
|
4
|
-
export declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
5
|
-
//# sourceMappingURL=client-utils.d.ts.map
|
package/dist/src/client.d.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import type { AbortSignal } from './types';
|
|
2
|
-
export type ClientOptions<TClientContext> = {
|
|
3
|
-
signal?: AbortSignal;
|
|
4
|
-
} & (undefined extends TClientContext ? {
|
|
5
|
-
context?: TClientContext;
|
|
6
|
-
} : {
|
|
7
|
-
context: TClientContext;
|
|
8
|
-
});
|
|
9
|
-
export type ClientRest<TClientContext, TInput> = [input: TInput, options: ClientOptions<TClientContext>] | (undefined extends TInput & TClientContext ? [] : never) | (undefined extends TClientContext ? [input: TInput] : never);
|
|
10
|
-
export type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
|
|
11
|
-
__typeError?: TError;
|
|
12
|
-
};
|
|
13
|
-
export interface Client<TClientContext, TInput, TOutput, TError extends Error> {
|
|
14
|
-
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
15
|
-
}
|
|
16
|
-
export type NestedClient<TClientContext> = Client<TClientContext, any, any, any> | {
|
|
17
|
-
[k: string]: NestedClient<TClientContext>;
|
|
18
|
-
};
|
|
19
|
-
//# sourceMappingURL=client.d.ts.map
|
package/dist/src/config.d.ts
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import type { HTTPMethod, InputStructure } from './types';
|
|
2
|
-
export interface ORPCConfig {
|
|
3
|
-
/**
|
|
4
|
-
* @default 'POST'
|
|
5
|
-
*/
|
|
6
|
-
defaultMethod?: HTTPMethod;
|
|
7
|
-
/**
|
|
8
|
-
*
|
|
9
|
-
* @default 200
|
|
10
|
-
*/
|
|
11
|
-
defaultSuccessStatus?: number;
|
|
12
|
-
/**
|
|
13
|
-
*
|
|
14
|
-
* @default 'OK'
|
|
15
|
-
*/
|
|
16
|
-
defaultSuccessDescription?: string;
|
|
17
|
-
/**
|
|
18
|
-
*
|
|
19
|
-
* @default 'compact'
|
|
20
|
-
*/
|
|
21
|
-
defaultInputStructure?: InputStructure;
|
|
22
|
-
/**
|
|
23
|
-
*
|
|
24
|
-
* @default 'compact'
|
|
25
|
-
*/
|
|
26
|
-
defaultOutputStructure?: InputStructure;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Set the global configuration, this configuration can effect entire project
|
|
30
|
-
*/
|
|
31
|
-
export declare function configGlobal(config: ORPCConfig): void;
|
|
32
|
-
/**
|
|
33
|
-
* Fallback the value to the global config if it is undefined
|
|
34
|
-
*/
|
|
35
|
-
export declare function fallbackToGlobalConfig<T extends keyof ORPCConfig>(key: T, value: ORPCConfig[T]): Exclude<ORPCConfig[T], undefined>;
|
|
36
|
-
//# sourceMappingURL=config.d.ts.map
|
package/dist/src/error-map.d.ts
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import type { CommonORPCErrorCode } from './error-orpc';
|
|
2
|
-
import type { Schema } from './types';
|
|
3
|
-
export type ErrorMapItem<TDataSchema extends Schema> = {
|
|
4
|
-
/**
|
|
5
|
-
*
|
|
6
|
-
* @default 500
|
|
7
|
-
*/
|
|
8
|
-
status?: number;
|
|
9
|
-
message?: string;
|
|
10
|
-
description?: string;
|
|
11
|
-
data?: TDataSchema;
|
|
12
|
-
};
|
|
13
|
-
export interface ErrorMap {
|
|
14
|
-
[k: string]: ErrorMapItem<Schema>;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* const U extends ErrorMap & ErrorMapGuard<TErrorMap> & ErrorMapSuggestions
|
|
18
|
-
*
|
|
19
|
-
* Purpose:
|
|
20
|
-
* - Helps `U` suggest `CommonORPCErrorCode` to the user when typing.
|
|
21
|
-
*
|
|
22
|
-
* Why not replace `ErrorMap` with `ErrorMapSuggestions`?
|
|
23
|
-
* - `ErrorMapSuggestions` has a drawback: it allows `undefined` values for items.
|
|
24
|
-
* - `ErrorMapGuard<TErrorMap>` uses `Partial`, which can introduce `undefined` values.
|
|
25
|
-
*
|
|
26
|
-
* This could lead to unintended behavior where `undefined` values override `TErrorMap`,
|
|
27
|
-
* potentially resulting in a `never` type after merging.
|
|
28
|
-
*
|
|
29
|
-
* Recommendation:
|
|
30
|
-
* - Use `ErrorMapSuggestions` to assist users in typing correctly but do not replace `ErrorMap`.
|
|
31
|
-
* - Ensure `ErrorMapGuard<TErrorMap>` is adjusted to prevent `undefined` values.
|
|
32
|
-
*/
|
|
33
|
-
export type ErrorMapSuggestions = {
|
|
34
|
-
[key in CommonORPCErrorCode | (string & {})]?: ErrorMapItem<Schema>;
|
|
35
|
-
};
|
|
36
|
-
/**
|
|
37
|
-
* `U` extends `ErrorMap` & `ErrorMapGuard<TErrorMap>`
|
|
38
|
-
*
|
|
39
|
-
* `ErrorMapGuard` is a utility type that ensures `U` cannot redefine the structure of `TErrorMap`.
|
|
40
|
-
* It achieves this by setting each key in `TErrorMap` to `never`, effectively preventing any redefinition.
|
|
41
|
-
*
|
|
42
|
-
* Why not just use `Partial<TErrorMap>`?
|
|
43
|
-
* - Allowing users to redefine existing error map items would require using `StrictErrorMap`.
|
|
44
|
-
* - However, I prefer not to use `StrictErrorMap` frequently, due to perceived performance concerns,
|
|
45
|
-
* though this has not been benchmarked and is based on personal preference.
|
|
46
|
-
*
|
|
47
|
-
*/
|
|
48
|
-
export type ErrorMapGuard<TErrorMap extends ErrorMap> = {
|
|
49
|
-
[K in keyof TErrorMap]?: never;
|
|
50
|
-
};
|
|
51
|
-
/**
|
|
52
|
-
* Since `undefined` has a specific meaning (it use default value),
|
|
53
|
-
* we ensure all additional properties in each item of the ErrorMap are explicitly set to `undefined`.
|
|
54
|
-
*/
|
|
55
|
-
export type StrictErrorMap<T extends ErrorMap> = {
|
|
56
|
-
[K in keyof T]: T[K] & Partial<Record<Exclude<keyof ErrorMapItem<any>, keyof T[K]>, undefined>>;
|
|
57
|
-
};
|
|
58
|
-
//# sourceMappingURL=error-map.d.ts.map
|
package/dist/src/error-orpc.d.ts
DELETED
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
import type { ErrorMap, ErrorMapItem } from './error-map';
|
|
2
|
-
import type { SchemaOutput } from './types';
|
|
3
|
-
export type ORPCErrorFromErrorMap<TErrorMap extends ErrorMap> = {
|
|
4
|
-
[K in keyof TErrorMap]: K extends string ? TErrorMap[K] extends ErrorMapItem<infer TDataSchema> ? ORPCError<K, SchemaOutput<TDataSchema>> : never : never;
|
|
5
|
-
}[keyof TErrorMap];
|
|
6
|
-
export declare const COMMON_ORPC_ERROR_DEFS: {
|
|
7
|
-
readonly BAD_REQUEST: {
|
|
8
|
-
readonly status: 400;
|
|
9
|
-
readonly message: "Bad Request";
|
|
10
|
-
};
|
|
11
|
-
readonly UNAUTHORIZED: {
|
|
12
|
-
readonly status: 401;
|
|
13
|
-
readonly message: "Unauthorized";
|
|
14
|
-
};
|
|
15
|
-
readonly FORBIDDEN: {
|
|
16
|
-
readonly status: 403;
|
|
17
|
-
readonly message: "Forbidden";
|
|
18
|
-
};
|
|
19
|
-
readonly NOT_FOUND: {
|
|
20
|
-
readonly status: 404;
|
|
21
|
-
readonly message: "Not Found";
|
|
22
|
-
};
|
|
23
|
-
readonly METHOD_NOT_SUPPORTED: {
|
|
24
|
-
readonly status: 405;
|
|
25
|
-
readonly message: "Method Not Supported";
|
|
26
|
-
};
|
|
27
|
-
readonly NOT_ACCEPTABLE: {
|
|
28
|
-
readonly status: 406;
|
|
29
|
-
readonly message: "Not Acceptable";
|
|
30
|
-
};
|
|
31
|
-
readonly TIMEOUT: {
|
|
32
|
-
readonly status: 408;
|
|
33
|
-
readonly message: "Request Timeout";
|
|
34
|
-
};
|
|
35
|
-
readonly CONFLICT: {
|
|
36
|
-
readonly status: 409;
|
|
37
|
-
readonly message: "Conflict";
|
|
38
|
-
};
|
|
39
|
-
readonly PRECONDITION_FAILED: {
|
|
40
|
-
readonly status: 412;
|
|
41
|
-
readonly message: "Precondition Failed";
|
|
42
|
-
};
|
|
43
|
-
readonly PAYLOAD_TOO_LARGE: {
|
|
44
|
-
readonly status: 413;
|
|
45
|
-
readonly message: "Payload Too Large";
|
|
46
|
-
};
|
|
47
|
-
readonly UNSUPPORTED_MEDIA_TYPE: {
|
|
48
|
-
readonly status: 415;
|
|
49
|
-
readonly message: "Unsupported Media Type";
|
|
50
|
-
};
|
|
51
|
-
readonly UNPROCESSABLE_CONTENT: {
|
|
52
|
-
readonly status: 422;
|
|
53
|
-
readonly message: "Unprocessable Content";
|
|
54
|
-
};
|
|
55
|
-
readonly TOO_MANY_REQUESTS: {
|
|
56
|
-
readonly status: 429;
|
|
57
|
-
readonly message: "Too Many Requests";
|
|
58
|
-
};
|
|
59
|
-
readonly CLIENT_CLOSED_REQUEST: {
|
|
60
|
-
readonly status: 499;
|
|
61
|
-
readonly message: "Client Closed Request";
|
|
62
|
-
};
|
|
63
|
-
readonly INTERNAL_SERVER_ERROR: {
|
|
64
|
-
readonly status: 500;
|
|
65
|
-
readonly message: "Internal Server Error";
|
|
66
|
-
};
|
|
67
|
-
readonly NOT_IMPLEMENTED: {
|
|
68
|
-
readonly status: 501;
|
|
69
|
-
readonly message: "Not Implemented";
|
|
70
|
-
};
|
|
71
|
-
readonly BAD_GATEWAY: {
|
|
72
|
-
readonly status: 502;
|
|
73
|
-
readonly message: "Bad Gateway";
|
|
74
|
-
};
|
|
75
|
-
readonly SERVICE_UNAVAILABLE: {
|
|
76
|
-
readonly status: 503;
|
|
77
|
-
readonly message: "Service Unavailable";
|
|
78
|
-
};
|
|
79
|
-
readonly GATEWAY_TIMEOUT: {
|
|
80
|
-
readonly status: 504;
|
|
81
|
-
readonly message: "Gateway Timeout";
|
|
82
|
-
};
|
|
83
|
-
};
|
|
84
|
-
export type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
|
|
85
|
-
export type ORPCErrorOptions<TCode extends string, TData> = ErrorOptions & {
|
|
86
|
-
defined?: boolean;
|
|
87
|
-
code: TCode;
|
|
88
|
-
status?: number;
|
|
89
|
-
message?: string;
|
|
90
|
-
} & (undefined extends TData ? {
|
|
91
|
-
data?: TData;
|
|
92
|
-
} : {
|
|
93
|
-
data: TData;
|
|
94
|
-
});
|
|
95
|
-
export declare function fallbackORPCErrorStatus(code: CommonORPCErrorCode | (string & {}), status: number | undefined): number;
|
|
96
|
-
export declare function fallbackORPCErrorMessage(code: CommonORPCErrorCode | (string & {}), message: string | undefined): string;
|
|
97
|
-
export declare class ORPCError<TCode extends CommonORPCErrorCode | (string & {}), TData> extends Error {
|
|
98
|
-
readonly defined: boolean;
|
|
99
|
-
readonly code: TCode;
|
|
100
|
-
readonly status: number;
|
|
101
|
-
readonly data: TData;
|
|
102
|
-
constructor(options: ORPCErrorOptions<TCode, TData>);
|
|
103
|
-
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
104
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<string, unknown>;
|
|
105
|
-
}
|
|
106
|
-
export type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
107
|
-
export declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
108
|
-
export declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
|
|
109
|
-
//# sourceMappingURL=error-orpc.d.ts.map
|
package/dist/src/error.d.ts
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { StandardSchemaV1 } from '@standard-schema/spec';
|
|
2
|
-
import type { ErrorMap } from './error-map';
|
|
3
|
-
import type { ORPCErrorFromErrorMap } from './error-orpc';
|
|
4
|
-
export type ErrorFromErrorMap<TErrorMap extends ErrorMap> = Error | ORPCErrorFromErrorMap<TErrorMap>;
|
|
5
|
-
export interface ValidationErrorOptions extends ErrorOptions {
|
|
6
|
-
message: string;
|
|
7
|
-
issues: readonly StandardSchemaV1.Issue[];
|
|
8
|
-
}
|
|
9
|
-
export declare class ValidationError extends Error {
|
|
10
|
-
readonly issues: readonly StandardSchemaV1.Issue[];
|
|
11
|
-
constructor(options: ValidationErrorOptions);
|
|
12
|
-
}
|
|
13
|
-
//# sourceMappingURL=error.d.ts.map
|
package/dist/src/index.d.ts
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/** unnoq */
|
|
2
|
-
import { ContractBuilder } from './builder';
|
|
3
|
-
export * from './builder';
|
|
4
|
-
export * from './client';
|
|
5
|
-
export * from './client-utils';
|
|
6
|
-
export * from './config';
|
|
7
|
-
export * from './error';
|
|
8
|
-
export * from './error-map';
|
|
9
|
-
export * from './error-orpc';
|
|
10
|
-
export * from './procedure';
|
|
11
|
-
export * from './procedure-client';
|
|
12
|
-
export * from './procedure-decorated';
|
|
13
|
-
export * from './router';
|
|
14
|
-
export * from './router-builder';
|
|
15
|
-
export * from './router-client';
|
|
16
|
-
export * from './types';
|
|
17
|
-
export declare const oc: ContractBuilder<Record<never, never>>;
|
|
18
|
-
//# sourceMappingURL=index.d.ts.map
|