@orpc/contract 0.0.0-next.c59d67c → 0.0.0-next.c6c659d

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/index.js CHANGED
@@ -1,93 +1,121 @@
1
1
  // src/procedure.ts
2
2
  var ContractProcedure = class {
3
- constructor(zz$cp) {
4
- this.zz$cp = zz$cp;
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;
5
13
  }
6
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
7
23
  var DecoratedContractProcedure = class _DecoratedContractProcedure extends ContractProcedure {
8
- static decorate(cp) {
9
- if (cp instanceof _DecoratedContractProcedure)
10
- return cp;
11
- return new _DecoratedContractProcedure(cp.zz$cp);
24
+ static decorate(procedure) {
25
+ if (procedure instanceof _DecoratedContractProcedure) {
26
+ return procedure;
27
+ }
28
+ return new _DecoratedContractProcedure(procedure["~orpc"]);
12
29
  }
13
- route(opts) {
30
+ route(route) {
14
31
  return new _DecoratedContractProcedure({
15
- ...this.zz$cp,
16
- ...opts,
17
- method: opts.method,
18
- path: opts.path
32
+ ...this["~orpc"],
33
+ route: {
34
+ ...this["~orpc"].route,
35
+ ...route
36
+ }
19
37
  });
20
38
  }
21
39
  prefix(prefix) {
22
- if (!this.zz$cp.path)
23
- return this;
24
40
  return new _DecoratedContractProcedure({
25
- ...this.zz$cp,
26
- path: `${prefix}${this.zz$cp.path}`
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
27
48
  });
28
49
  }
29
- addTags(...tags) {
30
- if (!tags.length)
31
- return this;
50
+ unshiftTag(...tags) {
32
51
  return new _DecoratedContractProcedure({
33
- ...this.zz$cp,
34
- tags: [...this.zz$cp.tags ?? [], ...tags]
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
+ }
35
60
  });
36
61
  }
37
62
  input(schema, example) {
38
63
  return new _DecoratedContractProcedure({
39
- ...this.zz$cp,
64
+ ...this["~orpc"],
40
65
  InputSchema: schema,
41
66
  inputExample: example
42
67
  });
43
68
  }
44
69
  output(schema, example) {
45
70
  return new _DecoratedContractProcedure({
46
- ...this.zz$cp,
71
+ ...this["~orpc"],
47
72
  OutputSchema: schema,
48
73
  outputExample: example
49
74
  });
50
75
  }
76
+ errors(errorMap) {
77
+ return new _DecoratedContractProcedure({
78
+ ...this["~orpc"],
79
+ errorMap
80
+ });
81
+ }
51
82
  };
52
- function isContractProcedure(item) {
53
- if (item instanceof ContractProcedure)
54
- return true;
55
- return (typeof item === "object" || typeof item === "function") && item !== null && "zz$cp" in item && typeof item.zz$cp === "object" && item.zz$cp !== null && "InputSchema" in item.zz$cp && "OutputSchema" in item.zz$cp;
56
- }
57
83
 
58
84
  // src/router-builder.ts
59
85
  var ContractRouterBuilder = class _ContractRouterBuilder {
60
- constructor(zz$crb) {
61
- this.zz$crb = zz$crb;
86
+ "~type" = "ContractProcedure";
87
+ "~orpc";
88
+ constructor(def) {
89
+ this["~orpc"] = def;
62
90
  }
63
91
  prefix(prefix) {
64
92
  return new _ContractRouterBuilder({
65
- ...this.zz$crb,
66
- prefix: `${this.zz$crb.prefix ?? ""}${prefix}`
93
+ ...this["~orpc"],
94
+ prefix: `${this["~orpc"].prefix ?? ""}${prefix}`
67
95
  });
68
96
  }
69
- tags(...tags) {
70
- if (!tags.length)
71
- return this;
97
+ tag(...tags) {
72
98
  return new _ContractRouterBuilder({
73
- ...this.zz$crb,
74
- tags: [...this.zz$crb.tags ?? [], ...tags]
99
+ ...this["~orpc"],
100
+ tags: [...this["~orpc"].tags ?? [], ...tags]
75
101
  });
76
102
  }
77
103
  router(router) {
78
- const handled = {};
79
- for (const key in router) {
80
- const item = router[key];
81
- if (isContractProcedure(item)) {
82
- const decorated = DecoratedContractProcedure.decorate(item).addTags(
83
- ...this.zz$crb.tags ?? []
84
- );
85
- handled[key] = this.zz$crb.prefix ? decorated.prefix(this.zz$crb.prefix) : decorated;
86
- } else {
87
- handled[key] = this.router(item);
104
+ if (isContractProcedure(router)) {
105
+ let decorated = DecoratedContractProcedure.decorate(router);
106
+ if (this["~orpc"].tags) {
107
+ decorated = decorated.unshiftTag(...this["~orpc"].tags);
108
+ }
109
+ if (this["~orpc"].prefix) {
110
+ decorated = decorated.prefix(this["~orpc"].prefix);
88
111
  }
112
+ return decorated;
113
+ }
114
+ const adapted = {};
115
+ for (const key in router) {
116
+ adapted[key] = this.router(router[key]);
89
117
  }
90
- return handled;
118
+ return adapted;
91
119
  }
92
120
  };
93
121
 
@@ -98,30 +126,40 @@ var ContractBuilder = class {
98
126
  prefix
99
127
  });
100
128
  }
101
- tags(...tags) {
129
+ tag(...tags) {
102
130
  return new ContractRouterBuilder({
103
131
  tags
104
132
  });
105
133
  }
106
- route(opts) {
134
+ route(route) {
107
135
  return new DecoratedContractProcedure({
136
+ route,
108
137
  InputSchema: void 0,
109
138
  OutputSchema: void 0,
110
- ...opts
139
+ errorMap: void 0
111
140
  });
112
141
  }
113
142
  input(schema, example) {
114
143
  return new DecoratedContractProcedure({
115
144
  InputSchema: schema,
116
145
  inputExample: example,
117
- OutputSchema: void 0
146
+ OutputSchema: void 0,
147
+ errorMap: void 0
118
148
  });
119
149
  }
120
150
  output(schema, example) {
121
151
  return new DecoratedContractProcedure({
122
- InputSchema: void 0,
123
152
  OutputSchema: schema,
124
- outputExample: example
153
+ outputExample: example,
154
+ InputSchema: void 0,
155
+ errorMap: void 0
156
+ });
157
+ }
158
+ errors(errorMap) {
159
+ return new DecoratedContractProcedure({
160
+ InputSchema: void 0,
161
+ OutputSchema: void 0,
162
+ errorMap
125
163
  });
126
164
  }
127
165
  router(router) {
@@ -129,48 +167,214 @@ var ContractBuilder = class {
129
167
  }
130
168
  };
131
169
 
132
- // src/constants.ts
133
- var ORPC_HEADER = "x-orpc-transformer";
134
- var ORPC_HEADER_VALUE = "t";
170
+ // src/error-orpc.ts
171
+ import { isPlainObject } from "@orpc/shared";
172
+ var COMMON_ORPC_ERROR_DEFS = {
173
+ BAD_REQUEST: {
174
+ status: 400,
175
+ message: "Bad Request"
176
+ },
177
+ UNAUTHORIZED: {
178
+ status: 401,
179
+ message: "Unauthorized"
180
+ },
181
+ FORBIDDEN: {
182
+ status: 403,
183
+ message: "Forbidden"
184
+ },
185
+ NOT_FOUND: {
186
+ status: 404,
187
+ message: "Not Found"
188
+ },
189
+ METHOD_NOT_SUPPORTED: {
190
+ status: 405,
191
+ message: "Method Not Supported"
192
+ },
193
+ NOT_ACCEPTABLE: {
194
+ status: 406,
195
+ message: "Not Acceptable"
196
+ },
197
+ TIMEOUT: {
198
+ status: 408,
199
+ message: "Request Timeout"
200
+ },
201
+ CONFLICT: {
202
+ status: 409,
203
+ message: "Conflict"
204
+ },
205
+ PRECONDITION_FAILED: {
206
+ status: 412,
207
+ message: "Precondition Failed"
208
+ },
209
+ PAYLOAD_TOO_LARGE: {
210
+ status: 413,
211
+ message: "Payload Too Large"
212
+ },
213
+ UNSUPPORTED_MEDIA_TYPE: {
214
+ status: 415,
215
+ message: "Unsupported Media Type"
216
+ },
217
+ UNPROCESSABLE_CONTENT: {
218
+ status: 422,
219
+ message: "Unprocessable Content"
220
+ },
221
+ TOO_MANY_REQUESTS: {
222
+ status: 429,
223
+ message: "Too Many Requests"
224
+ },
225
+ CLIENT_CLOSED_REQUEST: {
226
+ status: 499,
227
+ message: "Client Closed Request"
228
+ },
229
+ INTERNAL_SERVER_ERROR: {
230
+ status: 500,
231
+ message: "Internal Server Error"
232
+ },
233
+ NOT_IMPLEMENTED: {
234
+ status: 501,
235
+ message: "Not Implemented"
236
+ },
237
+ BAD_GATEWAY: {
238
+ status: 502,
239
+ message: "Bad Gateway"
240
+ },
241
+ SERVICE_UNAVAILABLE: {
242
+ status: 503,
243
+ message: "Service Unavailable"
244
+ },
245
+ GATEWAY_TIMEOUT: {
246
+ status: 504,
247
+ message: "Gateway Timeout"
248
+ }
249
+ };
250
+ function fallbackORPCErrorStatus(code, status) {
251
+ return status ?? COMMON_ORPC_ERROR_DEFS[code]?.status ?? 500;
252
+ }
253
+ function fallbackORPCErrorMessage(code, message) {
254
+ return message || COMMON_ORPC_ERROR_DEFS[code]?.message || code;
255
+ }
256
+ var ORPCError = class extends Error {
257
+ defined;
258
+ code;
259
+ status;
260
+ data;
261
+ constructor(options) {
262
+ if (options.status && (options.status < 400 || options.status >= 600)) {
263
+ throw new Error("[ORPCError] The error status code must be in the 400-599 range.");
264
+ }
265
+ const message = fallbackORPCErrorMessage(options.code, options.message);
266
+ super(message, options);
267
+ this.code = options.code;
268
+ this.status = fallbackORPCErrorStatus(options.code, options.status);
269
+ this.defined = options.defined ?? false;
270
+ this.data = options.data;
271
+ }
272
+ toJSON() {
273
+ return {
274
+ defined: this.defined,
275
+ code: this.code,
276
+ status: this.status,
277
+ message: this.message,
278
+ data: this.data
279
+ };
280
+ }
281
+ static isValidJSON(json) {
282
+ 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";
283
+ }
284
+ };
285
+ function isDefinedError(error) {
286
+ return error instanceof ORPCError && error.defined;
287
+ }
288
+ async function validateORPCError(map, error) {
289
+ const { code, status, message, data, cause, defined } = error;
290
+ const config = map?.[error.code];
291
+ if (!config || fallbackORPCErrorStatus(error.code, config.status) !== error.status) {
292
+ return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
293
+ }
294
+ if (!config.data) {
295
+ return defined ? error : new ORPCError({ defined: true, code, status, message, data, cause });
296
+ }
297
+ const validated = await config.data["~standard"].validate(error.data);
298
+ if (validated.issues) {
299
+ return defined ? new ORPCError({ defined: false, code, status, message, data, cause }) : error;
300
+ }
301
+ return new ORPCError({
302
+ defined: true,
303
+ code,
304
+ status,
305
+ message,
306
+ data: validated.value,
307
+ cause
308
+ });
309
+ }
135
310
 
136
- // src/router.ts
137
- function eachContractRouterLeaf(router, callback, prefix = []) {
138
- for (const key in router) {
139
- const item = router[key];
140
- if (isContractProcedure(item)) {
141
- callback(item, [...prefix, key]);
142
- } else {
143
- eachContractRouterLeaf(item, callback, [...prefix, key]);
311
+ // src/client-utils.ts
312
+ async function safe(promise) {
313
+ try {
314
+ const output = await promise;
315
+ return [output, void 0, false];
316
+ } catch (e) {
317
+ const error = e;
318
+ if (isDefinedError(error)) {
319
+ return [void 0, error, true];
144
320
  }
321
+ return [void 0, error, false];
145
322
  }
146
323
  }
147
324
 
148
- // src/utils.ts
149
- function standardizeHTTPPath(path) {
150
- return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
325
+ // src/config.ts
326
+ var DEFAULT_CONFIG = {
327
+ defaultMethod: "POST",
328
+ defaultSuccessStatus: 200,
329
+ defaultSuccessDescription: "OK",
330
+ defaultInputStructure: "compact",
331
+ defaultOutputStructure: "compact"
332
+ };
333
+ var GLOBAL_CONFIG_REF = { value: DEFAULT_CONFIG };
334
+ function configGlobal(config) {
335
+ if (config.defaultSuccessStatus !== void 0 && (config.defaultSuccessStatus < 200 || config.defaultSuccessStatus > 299)) {
336
+ throw new Error("[configGlobal] The defaultSuccessStatus must be between 200 and 299");
337
+ }
338
+ GLOBAL_CONFIG_REF.value = config;
151
339
  }
152
- function prefixHTTPPath(prefix, path) {
153
- const prefix_ = standardizeHTTPPath(prefix);
154
- const path_ = standardizeHTTPPath(path);
155
- if (prefix_ === "/")
156
- return path_;
157
- if (path_ === "/")
158
- return prefix_;
159
- return `${prefix_}${path_}`;
340
+ function fallbackToGlobalConfig(key, value) {
341
+ if (value === void 0) {
342
+ const fallback = GLOBAL_CONFIG_REF.value[key];
343
+ if (fallback === void 0) {
344
+ return DEFAULT_CONFIG[key];
345
+ }
346
+ return fallback;
347
+ }
348
+ return value;
160
349
  }
161
350
 
351
+ // src/error.ts
352
+ var ValidationError = class extends Error {
353
+ issues;
354
+ constructor(options) {
355
+ super(options.message, options);
356
+ this.issues = options.issues;
357
+ }
358
+ };
359
+
162
360
  // src/index.ts
163
361
  var oc = new ContractBuilder();
164
362
  export {
363
+ COMMON_ORPC_ERROR_DEFS,
165
364
  ContractBuilder,
166
365
  ContractProcedure,
366
+ ContractRouterBuilder,
167
367
  DecoratedContractProcedure,
168
- ORPC_HEADER,
169
- ORPC_HEADER_VALUE,
170
- eachContractRouterLeaf,
368
+ ORPCError,
369
+ ValidationError,
370
+ configGlobal,
371
+ fallbackORPCErrorMessage,
372
+ fallbackORPCErrorStatus,
373
+ fallbackToGlobalConfig,
171
374
  isContractProcedure,
375
+ isDefinedError,
172
376
  oc,
173
- prefixHTTPPath,
174
- standardizeHTTPPath
377
+ safe,
378
+ validateORPCError
175
379
  };
176
380
  //# sourceMappingURL=index.js.map
@@ -1,13 +1,16 @@
1
+ import type { ErrorMap } from './error-map';
2
+ import type { RouteOptions } from './procedure';
1
3
  import type { ContractRouter } from './router';
2
4
  import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
3
- import { DecoratedContractProcedure, type RouteOptions } from './procedure';
5
+ import { DecoratedContractProcedure } from './procedure-decorated';
4
6
  import { ContractRouterBuilder } from './router-builder';
5
7
  export declare class ContractBuilder {
6
8
  prefix(prefix: HTTPPath): ContractRouterBuilder;
7
- tags(...tags: string[]): ContractRouterBuilder;
8
- route(opts: RouteOptions): DecoratedContractProcedure<undefined, undefined>;
9
- input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): DecoratedContractProcedure<USchema, undefined>;
10
- output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): DecoratedContractProcedure<undefined, USchema>;
9
+ tag(...tags: string[]): ContractRouterBuilder;
10
+ route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined, undefined>;
11
+ input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined, undefined>;
12
+ output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U, undefined>;
13
+ errors<const U extends ErrorMap>(errorMap: U): DecoratedContractProcedure<undefined, undefined, U>;
11
14
  router<T extends ContractRouter>(router: T): T;
12
15
  }
13
16
  //# sourceMappingURL=builder.d.ts.map
@@ -0,0 +1,5 @@
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
@@ -0,0 +1,19 @@
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
@@ -0,0 +1,36 @@
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
@@ -0,0 +1,16 @@
1
+ import type { CommonORPCErrorCode } from './error-orpc';
2
+ import type { Schema } from './types';
3
+ export type ErrorMapItem<TDataSchema extends Schema> = {
4
+ /**
5
+ *
6
+ * @default 200
7
+ */
8
+ status?: number;
9
+ message?: string;
10
+ description?: string;
11
+ data?: TDataSchema;
12
+ };
13
+ export type ErrorMap = undefined | {
14
+ [key in CommonORPCErrorCode | (string & {})]?: ErrorMapItem<Schema>;
15
+ };
16
+ //# sourceMappingURL=error-map.d.ts.map
@@ -0,0 +1,109 @@
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
@@ -0,0 +1,13 @@
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
@@ -1,10 +1,16 @@
1
1
  /** unnoq */
2
2
  import { ContractBuilder } from './builder';
3
3
  export * from './builder';
4
- export * from './constants';
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';
5
10
  export * from './procedure';
11
+ export * from './procedure-decorated';
6
12
  export * from './router';
13
+ export * from './router-builder';
7
14
  export * from './types';
8
- export * from './utils';
9
15
  export declare const oc: ContractBuilder;
10
16
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,14 @@
1
+ import type { ErrorMap } from './error-map';
2
+ import type { RouteOptions } from './procedure';
3
+ import type { HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
4
+ import { ContractProcedure } from './procedure';
5
+ export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap> {
6
+ static decorate<UInputSchema extends Schema, UOutputSchema extends Schema, TErrorMap extends ErrorMap>(procedure: ContractProcedure<UInputSchema, UOutputSchema, TErrorMap>): DecoratedContractProcedure<UInputSchema, UOutputSchema, TErrorMap>;
7
+ route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
8
+ prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
9
+ unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema, TErrorMap>;
10
+ input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema, TErrorMap>;
11
+ output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U, TErrorMap>;
12
+ errors<const U extends ErrorMap>(errorMap: U): DecoratedContractProcedure<TInputSchema, TOutputSchema, U>;
13
+ }
14
+ //# sourceMappingURL=procedure-decorated.d.ts.map
@@ -1,46 +1,83 @@
1
- import type { HTTPMethod, HTTPPath, Schema, SchemaInput, SchemaOutput } from './types';
1
+ import type { ErrorMap } from './error-map';
2
+ import type { HTTPMethod, HTTPPath, InputStructure, OutputStructure, Schema, SchemaOutput } from './types';
2
3
  export interface RouteOptions {
3
4
  method?: HTTPMethod;
4
5
  path?: HTTPPath;
5
6
  summary?: string;
6
7
  description?: string;
7
8
  deprecated?: boolean;
8
- tags?: string[];
9
+ tags?: readonly string[];
10
+ /**
11
+ * The status code of the response when the procedure is successful.
12
+ *
13
+ * @default 200
14
+ */
15
+ successStatus?: number;
16
+ /**
17
+ * The description of the response when the procedure is successful.
18
+ *
19
+ * @default 'OK'
20
+ */
21
+ successDescription?: string;
22
+ /**
23
+ * Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
24
+ *
25
+ * @option 'compact'
26
+ * Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
27
+ *
28
+ * @option 'detailed'
29
+ * Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
30
+ *
31
+ * Example:
32
+ * ```ts
33
+ * const input = {
34
+ * params: { id: 1 },
35
+ * query: { search: 'hello' },
36
+ * headers: { 'Content-Type': 'application/json' },
37
+ * body: { name: 'John' },
38
+ * }
39
+ * ```
40
+ *
41
+ * @default 'compact'
42
+ */
43
+ inputStructure?: InputStructure;
44
+ /**
45
+ * Determines how the response should be structured based on the output.
46
+ *
47
+ * @option 'compact'
48
+ * Includes only the body data, encoded directly in the response.
49
+ *
50
+ * @option 'detailed'
51
+ * Separates the output into `headers` and `body` fields.
52
+ * - `headers`: Custom headers to merge with the response headers.
53
+ * - `body`: The response data.
54
+ *
55
+ * Example:
56
+ * ```ts
57
+ * const output = {
58
+ * headers: { 'x-custom-header': 'value' },
59
+ * body: { message: 'Hello, world!' },
60
+ * };
61
+ * ```
62
+ *
63
+ * @default 'compact'
64
+ */
65
+ outputStructure?: OutputStructure;
9
66
  }
10
- export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> {
11
- zz$cp: {
12
- path?: HTTPPath;
13
- method?: HTTPMethod;
14
- summary?: string;
15
- description?: string;
16
- deprecated?: boolean;
17
- tags?: string[];
18
- InputSchema: TInputSchema;
19
- inputExample?: SchemaOutput<TInputSchema>;
20
- OutputSchema: TOutputSchema;
21
- outputExample?: SchemaOutput<TOutputSchema>;
22
- };
23
- constructor(zz$cp: {
24
- path?: HTTPPath;
25
- method?: HTTPMethod;
26
- summary?: string;
27
- description?: string;
28
- deprecated?: boolean;
29
- tags?: string[];
30
- InputSchema: TInputSchema;
31
- inputExample?: SchemaOutput<TInputSchema>;
32
- OutputSchema: TOutputSchema;
33
- outputExample?: SchemaOutput<TOutputSchema>;
34
- });
67
+ export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
68
+ route?: RouteOptions;
69
+ InputSchema: TInputSchema;
70
+ inputExample?: SchemaOutput<TInputSchema>;
71
+ OutputSchema: TOutputSchema;
72
+ outputExample?: SchemaOutput<TOutputSchema>;
73
+ errorMap: TErrorMap;
35
74
  }
36
- export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema> extends ContractProcedure<TInputSchema, TOutputSchema> {
37
- static decorate<TInputSchema extends Schema, TOutputSchema extends Schema>(cp: ContractProcedure<TInputSchema, TOutputSchema>): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
38
- route(opts: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
39
- prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
40
- addTags(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
41
- input<USchema extends Schema>(schema: USchema, example?: SchemaInput<USchema>): DecoratedContractProcedure<USchema, TOutputSchema>;
42
- output<USchema extends Schema>(schema: USchema, example?: SchemaOutput<USchema>): DecoratedContractProcedure<TInputSchema, USchema>;
75
+ export declare class ContractProcedure<TInputSchema extends Schema, TOutputSchema extends Schema, TErrorMap extends ErrorMap> {
76
+ '~type': "ContractProcedure";
77
+ '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>;
78
+ constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap>);
43
79
  }
44
- export type WELL_DEFINED_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema>;
45
- export declare function isContractProcedure(item: unknown): item is WELL_DEFINED_CONTRACT_PROCEDURE;
80
+ export type ANY_CONTRACT_PROCEDURE = ContractProcedure<any, any, any>;
81
+ export type WELL_CONTRACT_PROCEDURE = ContractProcedure<Schema, Schema, ErrorMap>;
82
+ export declare function isContractProcedure(item: unknown): item is ANY_CONTRACT_PROCEDURE;
46
83
  //# sourceMappingURL=procedure.d.ts.map
@@ -1,16 +1,20 @@
1
- import type { ContractRouter, HandledContractRouter } from './router';
1
+ import type { ContractProcedure } from './procedure';
2
+ import type { ContractRouter } from './router';
2
3
  import type { HTTPPath } from './types';
4
+ import { DecoratedContractProcedure } from './procedure-decorated';
5
+ export type AdaptedContractRouter<TContract extends ContractRouter> = {
6
+ [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrors> ? DecoratedContractProcedure<UInputSchema, UOutputSchema, UErrors> : TContract[K] extends ContractRouter ? AdaptedContractRouter<TContract[K]> : never;
7
+ };
8
+ export interface ContractRouterBuilderDef {
9
+ prefix?: HTTPPath;
10
+ tags?: string[];
11
+ }
3
12
  export declare class ContractRouterBuilder {
4
- zz$crb: {
5
- prefix?: HTTPPath;
6
- tags?: string[];
7
- };
8
- constructor(zz$crb: {
9
- prefix?: HTTPPath;
10
- tags?: string[];
11
- });
13
+ '~type': "ContractProcedure";
14
+ '~orpc': ContractRouterBuilderDef;
15
+ constructor(def: ContractRouterBuilderDef);
12
16
  prefix(prefix: HTTPPath): ContractRouterBuilder;
13
- tags(...tags: string[]): ContractRouterBuilder;
14
- router<T extends ContractRouter>(router: T): HandledContractRouter<T>;
17
+ tag(...tags: string[]): ContractRouterBuilder;
18
+ router<T extends ContractRouter>(router: T): AdaptedContractRouter<T>;
15
19
  }
16
20
  //# sourceMappingURL=router-builder.d.ts.map
@@ -1,16 +1,12 @@
1
+ import type { ANY_CONTRACT_PROCEDURE, ContractProcedure } from './procedure';
1
2
  import type { SchemaInput, SchemaOutput } from './types';
2
- import { type ContractProcedure, type DecoratedContractProcedure, type WELL_DEFINED_CONTRACT_PROCEDURE } from './procedure';
3
- export interface ContractRouter {
4
- [k: string]: ContractProcedure<any, any> | ContractRouter;
5
- }
6
- export type HandledContractRouter<TContract extends ContractRouter> = {
7
- [K in keyof TContract]: TContract[K] extends ContractProcedure<infer UInputSchema, infer UOutputSchema> ? DecoratedContractProcedure<UInputSchema, UOutputSchema> : TContract[K] extends ContractRouter ? HandledContractRouter<TContract[K]> : never;
3
+ export type ContractRouter = ANY_CONTRACT_PROCEDURE | {
4
+ [k: string]: ContractRouter;
8
5
  };
9
- export declare function eachContractRouterLeaf(router: ContractRouter, callback: (item: WELL_DEFINED_CONTRACT_PROCEDURE, path: string[]) => void, prefix?: string[]): void;
10
- export type InferContractRouterInputs<T extends ContractRouter> = {
11
- [K in keyof T]: T[K] extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
6
+ export type InferContractRouterInputs<T extends ContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any> ? SchemaInput<UInputSchema> : {
7
+ [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
12
8
  };
13
- export type InferContractRouterOutputs<T extends ContractRouter> = {
14
- [K in keyof T]: T[K] extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
9
+ export type InferContractRouterOutputs<T extends ContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any> ? SchemaOutput<UOutputSchema> : {
10
+ [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
15
11
  };
16
12
  //# sourceMappingURL=router.d.ts.map
@@ -1,8 +1,11 @@
1
- import type { input, output, ZodType } from 'zod';
1
+ import type { FindGlobalInstanceType } from '@orpc/shared';
2
+ import type { StandardSchemaV1 } from '@standard-schema/spec';
2
3
  export type HTTPPath = `/${string}`;
3
4
  export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
4
- export type HTTPStatus = number;
5
- export type Schema = ZodType<any, any, any> | undefined;
6
- export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends ZodType<any, any, any> ? input<TSchema> : TFallback;
7
- export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends ZodType<any, any, any> ? output<TSchema> : TFallback;
5
+ export type InputStructure = 'compact' | 'detailed';
6
+ export type OutputStructure = 'compact' | 'detailed';
7
+ export type Schema = StandardSchemaV1 | undefined;
8
+ export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
9
+ export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;
10
+ export type AbortSignal = FindGlobalInstanceType<'AbortSignal'>;
8
11
  //# sourceMappingURL=types.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/contract",
3
3
  "type": "module",
4
- "version": "0.0.0-next.c59d67c",
4
+ "version": "0.0.0-next.c6c659d",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -28,11 +28,14 @@
28
28
  "!**/*.tsbuildinfo",
29
29
  "dist"
30
30
  ],
31
- "peerDependencies": {
32
- "zod": ">=3.23.0"
33
- },
34
31
  "dependencies": {
35
- "@orpc/shared": "0.0.0-next.c59d67c"
32
+ "@standard-schema/spec": "1.0.0-beta.4",
33
+ "@orpc/shared": "0.0.0-next.c6c659d"
34
+ },
35
+ "devDependencies": {
36
+ "arktype": "2.0.0-rc.26",
37
+ "valibot": "1.0.0-beta.9",
38
+ "zod": "3.24.1"
36
39
  },
37
40
  "scripts": {
38
41
  "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
@@ -1,3 +0,0 @@
1
- export declare const ORPC_HEADER = "x-orpc-transformer";
2
- export declare const ORPC_HEADER_VALUE = "t";
3
- //# sourceMappingURL=constants.d.ts.map
@@ -1,4 +0,0 @@
1
- import type { HTTPPath } from './types';
2
- export declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
3
- export declare function prefixHTTPPath(prefix: HTTPPath, path: HTTPPath): HTTPPath;
4
- //# sourceMappingURL=utils.d.ts.map