@orpc/contract 0.0.0-next.ee46dab → 0.0.0-next.ee5598c

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 CHANGED
@@ -21,28 +21,24 @@
21
21
 
22
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
23
23
 
24
- **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
24
+ **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
25
25
 
26
26
  ---
27
27
 
28
28
  ## Highlights
29
29
 
30
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
31
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
32
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
36
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
39
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
40
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
41
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
42
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
43
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
44
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
45
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
34
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
37
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
38
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
+ - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
46
42
 
47
43
  ## Documentation
48
44
 
@@ -53,13 +49,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
56
54
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
57
- - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
58
- - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
59
- - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
60
- - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
55
+ - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
61
56
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
62
- - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
57
+ - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
63
58
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
64
59
  - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
65
60
  - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
package/dist/index.d.mts CHANGED
@@ -3,6 +3,8 @@ export { HTTPMethod, HTTPPath, ORPCError } from '@orpc/client';
3
3
  import { Promisable, IsEqual, ThrowableError } from '@orpc/shared';
4
4
  export { Registry, ThrowableError } from '@orpc/shared';
5
5
  import { StandardSchemaV1 } from '@standard-schema/spec';
6
+ import { OpenAPIV3_1 } from 'openapi-types';
7
+ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
6
8
 
7
9
  type Schema<TInput, TOutput> = StandardSchemaV1<TInput, TOutput>;
8
10
  type AnySchema = Schema<any, any>;
@@ -10,12 +12,23 @@ type SchemaIssue = StandardSchemaV1.Issue;
10
12
  type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
11
13
  type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
12
14
  type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
15
+ /**
16
+ * The schema for things can be trust without validation.
17
+ * If the TInput and TOutput are different, you need pass a map function.
18
+ *
19
+ * @see {@link https://orpc.unnoq.com/docs/procedure#type-utility Type Utility Docs}
20
+ */
13
21
  declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
14
22
 
15
23
  interface ValidationErrorOptions extends ErrorOptions {
16
24
  message: string;
17
25
  issues: readonly SchemaIssue[];
18
26
  }
27
+ /**
28
+ * This errors usually used for ORPCError.cause when the error is a validation error.
29
+ *
30
+ * @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
31
+ */
19
32
  declare class ValidationError extends Error {
20
33
  readonly issues: readonly SchemaIssue[];
21
34
  constructor(options: ValidationErrorOptions);
@@ -41,21 +54,62 @@ declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
41
54
  type InputStructure = 'compact' | 'detailed';
42
55
  type OutputStructure = 'compact' | 'detailed';
43
56
  interface Route {
57
+ /**
58
+ * The HTTP method of the procedure.
59
+ * This option is typically relevant when integrating with OpenAPI.
60
+ *
61
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
62
+ */
44
63
  method?: HTTPMethod;
64
+ /**
65
+ * The HTTP path of the procedure.
66
+ * This option is typically relevant when integrating with OpenAPI.
67
+ *
68
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
69
+ */
45
70
  path?: HTTPPath;
71
+ /**
72
+ * The summary of the procedure.
73
+ * This option is typically relevant when integrating with OpenAPI.
74
+ *
75
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
76
+ */
46
77
  summary?: string;
78
+ /**
79
+ * The description of the procedure.
80
+ * This option is typically relevant when integrating with OpenAPI.
81
+ *
82
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
83
+ */
47
84
  description?: string;
85
+ /**
86
+ * Marks the procedure as deprecated.
87
+ * This option is typically relevant when integrating with OpenAPI.
88
+ *
89
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
90
+ */
48
91
  deprecated?: boolean;
92
+ /**
93
+ * The tags of the procedure.
94
+ * This option is typically relevant when integrating with OpenAPI.
95
+ *
96
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
97
+ */
49
98
  tags?: readonly string[];
50
99
  /**
51
100
  * The status code of the response when the procedure is successful.
101
+ * The status code must be in the 200-399 range.
102
+ * This option is typically relevant when integrating with OpenAPI.
52
103
  *
104
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
53
105
  * @default 200
54
106
  */
55
107
  successStatus?: number;
56
108
  /**
57
109
  * The description of the response when the procedure is successful.
110
+ * This option is typically relevant when integrating with OpenAPI.
58
111
  *
112
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
59
113
  * @default 'OK'
60
114
  */
61
115
  successDescription?: string;
@@ -78,6 +132,7 @@ interface Route {
78
132
  * }
79
133
  * ```
80
134
  *
135
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
81
136
  * @default 'compact'
82
137
  */
83
138
  inputStructure?: InputStructure;
@@ -85,24 +140,33 @@ interface Route {
85
140
  * Determines how the response should be structured based on the output.
86
141
  *
87
142
  * @option 'compact'
88
- * Includes only the body data, encoded directly in the response.
143
+ * The output data is directly returned as the response body.
89
144
  *
90
145
  * @option 'detailed'
91
- * Separates the output into `headers` and `body` fields.
92
- * - `headers`: Custom headers to merge with the response headers.
93
- * - `body`: The response data.
146
+ * Return an object with optional properties:
147
+ * - `status`: The response status (must be in 200-399 range) if not set fallback to `successStatus`.
148
+ * - `headers`: Custom headers to merge with the response headers (`Record<string, string | string[] | undefined>`)
149
+ * - `body`: The response body.
94
150
  *
95
151
  * Example:
96
152
  * ```ts
97
153
  * const output = {
154
+ * status: 201,
98
155
  * headers: { 'x-custom-header': 'value' },
99
156
  * body: { message: 'Hello, world!' },
100
157
  * };
101
158
  * ```
102
159
  *
160
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
103
161
  * @default 'compact'
104
162
  */
105
163
  outputStructure?: OutputStructure;
164
+ /**
165
+ * Override entire auto-generated OpenAPI Operation Object Specification.
166
+ *
167
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata Operation Metadata Docs}
168
+ */
169
+ spec?: OpenAPIV3_1.OperationObject;
106
170
  }
107
171
  declare function mergeRoute(a: Route, b: Route): Route;
108
172
  declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
@@ -122,23 +186,55 @@ interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema ext
122
186
  outputSchema?: TOutputSchema;
123
187
  errorMap: TErrorMap;
124
188
  }
189
+ /**
190
+ * This class represents a contract procedure.
191
+ *
192
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract Contract Procedure Docs}
193
+ */
125
194
  declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
195
+ /**
196
+ * This property holds the defined options for the contract procedure.
197
+ */
126
198
  '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
127
199
  constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
128
200
  }
129
201
  type AnyContractProcedure = ContractProcedure<any, any, any, any>;
130
202
  declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
131
203
 
204
+ /**
205
+ * Represents a contract router, which defines a hierarchical structure of contract procedures.
206
+ *
207
+ * @info A contract procedure is a contract router too.
208
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
209
+ */
132
210
  type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
133
211
  [k: string]: ContractRouter<TMeta>;
134
212
  };
135
213
  type AnyContractRouter = ContractRouter<any>;
214
+ /**
215
+ * Infer all inputs of the contract router.
216
+ *
217
+ * @info A contract procedure is a contract router too.
218
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
219
+ */
136
220
  type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
137
221
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
138
222
  };
223
+ /**
224
+ * Infer all outputs of the contract router.
225
+ *
226
+ * @info A contract procedure is a contract router too.
227
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
228
+ */
139
229
  type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
140
230
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
141
231
  };
232
+ /**
233
+ * Infer all errors of the contract router.
234
+ *
235
+ * @info A contract procedure is a contract router too.
236
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
237
+ */
142
238
  type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
143
239
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
144
240
  }[keyof T];
@@ -152,59 +248,254 @@ interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends Enhan
152
248
  errorMap: TErrorMap;
153
249
  }
154
250
  declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
251
+ /**
252
+ * Minify a contract router into a smaller object.
253
+ *
254
+ * You should export the result to a JSON file. On the client side, you can import this JSON file and use it as a contract router.
255
+ * This reduces the size of the contract and helps prevent leaking internal details of the router to the client.
256
+ *
257
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/router-to-contract#minify-export-the-contract-router-for-the-client Router to Contract Docs}
258
+ */
259
+ declare function minifyContractRouter(router: AnyContractRouter): AnyContractRouter;
155
260
 
156
261
  interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
262
+ /**
263
+ * Adds type-safe custom errors to the contract.
264
+ * The provided errors are spared-merged with any existing errors in the contract.
265
+ *
266
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
267
+ */
157
268
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
269
+ /**
270
+ * Sets or updates the metadata for the contract.
271
+ * The provided metadata is spared-merged with any existing metadata in the contract.
272
+ *
273
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
274
+ */
158
275
  meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
276
+ /**
277
+ * Sets or updates the route definition for the contract.
278
+ * The provided route is spared-merged with any existing route in the contract.
279
+ * This option is typically relevant when integrating with OpenAPI.
280
+ *
281
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
282
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
283
+ */
159
284
  route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
285
+ /**
286
+ * Defines the input validation schema for the contract.
287
+ *
288
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
289
+ */
160
290
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
291
+ /**
292
+ * Defines the output validation schema for the contract.
293
+ *
294
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
295
+ */
161
296
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
162
297
  }
163
298
  interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
299
+ /**
300
+ * Adds type-safe custom errors to the contract.
301
+ * The provided errors are spared-merged with any existing errors in the contract.
302
+ *
303
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
304
+ */
164
305
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
306
+ /**
307
+ * Sets or updates the metadata for the contract.
308
+ * The provided metadata is spared-merged with any existing metadata in the contract.
309
+ *
310
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
311
+ */
165
312
  meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
313
+ /**
314
+ * Sets or updates the route definition for the contract.
315
+ * The provided route is spared-merged with any existing route in the contract.
316
+ * This option is typically relevant when integrating with OpenAPI.
317
+ *
318
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
319
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
320
+ */
166
321
  route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
322
+ /**
323
+ * Defines the output validation schema for the contract.
324
+ *
325
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
326
+ */
167
327
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
168
328
  }
169
329
  interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
330
+ /**
331
+ * Adds type-safe custom errors to the contract.
332
+ * The provided errors are spared-merged with any existing errors in the contract.
333
+ *
334
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
335
+ */
170
336
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
337
+ /**
338
+ * Sets or updates the metadata for the contract.
339
+ * The provided metadata is spared-merged with any existing metadata in the contract.
340
+ *
341
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
342
+ */
171
343
  meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
344
+ /**
345
+ * Sets or updates the route definition for the contract.
346
+ * The provided route is spared-merged with any existing route in the contract.
347
+ * This option is typically relevant when integrating with OpenAPI.
348
+ *
349
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
350
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
351
+ */
172
352
  route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
353
+ /**
354
+ * Defines the input validation schema for the contract.
355
+ *
356
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
357
+ */
173
358
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
174
359
  }
175
360
  interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
361
+ /**
362
+ * Adds type-safe custom errors to the contract.
363
+ * The provided errors are spared-merged with any existing errors in the contract.
364
+ *
365
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
366
+ */
176
367
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
368
+ /**
369
+ * Sets or updates the metadata for the contract.
370
+ * The provided metadata is spared-merged with any existing metadata in the contract.
371
+ *
372
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
373
+ */
177
374
  meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
375
+ /**
376
+ * Sets or updates the route definition for the contract.
377
+ * The provided route is spared-merged with any existing route in the contract.
378
+ * This option is typically relevant when integrating with OpenAPI.
379
+ *
380
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
381
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
382
+ */
178
383
  route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
179
384
  }
180
385
  interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
386
+ /**
387
+ * This property holds the defined options for the contract router.
388
+ */
181
389
  '~orpc': EnhanceContractRouterOptions<TErrorMap>;
390
+ /**
391
+ * Adds type-safe custom errors to the contract.
392
+ * The provided errors are spared-merged with any existing errors in the contract.
393
+ *
394
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
395
+ */
182
396
  'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
397
+ /**
398
+ * Prefixes all procedures in the contract router.
399
+ * The provided prefix is post-appended to any existing router prefix.
400
+ *
401
+ * @note This option does not affect procedures that do not define a path in their route definition.
402
+ *
403
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
404
+ */
183
405
  'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
406
+ /**
407
+ * Adds tags to all procedures in the contract router.
408
+ * This helpful when you want to group procedures together in the OpenAPI specification.
409
+ *
410
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
411
+ */
184
412
  'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
413
+ /**
414
+ * Applies all of the previously defined options to the specified contract router.
415
+ *
416
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
417
+ */
185
418
  'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
186
419
  }
187
420
 
188
421
  interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
189
422
  }
190
423
  declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
424
+ /**
425
+ * This property holds the defined options for the contract.
426
+ */
191
427
  '~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
192
428
  constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
193
429
  /**
194
- * Reset initial meta
430
+ * Sets or overrides the initial meta.
431
+ *
432
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
195
433
  */
196
434
  $meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
197
435
  /**
198
- * Reset initial route
436
+ * Sets or overrides the initial route.
437
+ * This option is typically relevant when integrating with OpenAPI.
438
+ *
439
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
440
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
199
441
  */
200
442
  $route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
443
+ /**
444
+ * Adds type-safe custom errors to the contract.
445
+ * The provided errors are spared-merged with any existing errors in the contract.
446
+ *
447
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
448
+ */
201
449
  errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
450
+ /**
451
+ * Sets or updates the metadata for the contract.
452
+ * The provided metadata is spared-merged with any existing metadata in the contract.
453
+ *
454
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
455
+ */
202
456
  meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
457
+ /**
458
+ * Sets or updates the route definition for the contract.
459
+ * The provided route is spared-merged with any existing route in the contract.
460
+ * This option is typically relevant when integrating with OpenAPI.
461
+ *
462
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
463
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
464
+ */
203
465
  route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
466
+ /**
467
+ * Defines the input validation schema for the contract.
468
+ *
469
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
470
+ */
204
471
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
472
+ /**
473
+ * Defines the output validation schema for the contract.
474
+ *
475
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
476
+ */
205
477
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
478
+ /**
479
+ * Prefixes all procedures in the contract router.
480
+ * The provided prefix is post-appended to any existing router prefix.
481
+ *
482
+ * @note This option does not affect procedures that do not define a path in their route definition.
483
+ *
484
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
485
+ */
206
486
  prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
487
+ /**
488
+ * Adds tags to all procedures in the contract router.
489
+ * This helpful when you want to group procedures together in the OpenAPI specification.
490
+ *
491
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
492
+ */
207
493
  tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
494
+ /**
495
+ * Applies all of the previously defined options to the specified contract router.
496
+ *
497
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
498
+ */
208
499
  router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
209
500
  }
210
501
  declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
@@ -222,13 +513,28 @@ interface EventIteratorSchemaDetails {
222
513
  yields: AnySchema;
223
514
  returns?: AnySchema;
224
515
  }
516
+ /**
517
+ * Define schema for an event iterator.
518
+ *
519
+ * @see {@link https://orpc.unnoq.com/docs/event-iterator#validate-event-iterator Validate Event Iterator Docs}
520
+ */
225
521
  declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
226
522
  declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
227
523
 
524
+ /**
525
+ * Help RPCLink automatically send requests using the specified HTTP method in the contract.
526
+ *
527
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link#custom-request-method RPCLink Custom Request Method}
528
+ */
529
+ declare function inferRPCMethodFromContractRouter(contract: AnyContractRouter): (options: unknown, path: readonly string[]) => Exclude<HTTPMethod, 'HEAD'>;
530
+
228
531
  type ContractProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
229
532
 
230
533
  type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
231
534
  [K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
232
535
  };
233
536
 
234
- export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
537
+ declare function isSchemaIssue(issue: unknown): issue is SchemaIssue;
538
+
539
+ export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, inferRPCMethodFromContractRouter, isContractProcedure, isSchemaIssue, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, minifyContractRouter, oc, prefixRoute, type, unshiftTagRoute };
540
+ export type { AnyContractProcedure, AnyContractRouter, AnySchema, ContractBuilderDef, ContractConfig, ContractProcedureBuilder, ContractProcedureBuilderWithInput, ContractProcedureBuilderWithInputOutput, ContractProcedureBuilderWithOutput, ContractProcedureClient, ContractProcedureDef, ContractRouter, ContractRouterBuilder, ContractRouterClient, EnhanceContractRouterOptions, EnhanceRouteOptions, EnhancedContractRouter, ErrorFromErrorMap, ErrorMap, ErrorMapItem, EventIteratorSchemaDetails, InferContractRouterErrorMap, InferContractRouterInputs, InferContractRouterMeta, InferContractRouterOutputs, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, ORPCErrorFromErrorMap, OutputStructure, Route, Schema, SchemaIssue, TypeRest, ValidationErrorOptions };
package/dist/index.d.ts CHANGED
@@ -3,6 +3,8 @@ export { HTTPMethod, HTTPPath, ORPCError } from '@orpc/client';
3
3
  import { Promisable, IsEqual, ThrowableError } from '@orpc/shared';
4
4
  export { Registry, ThrowableError } from '@orpc/shared';
5
5
  import { StandardSchemaV1 } from '@standard-schema/spec';
6
+ import { OpenAPIV3_1 } from 'openapi-types';
7
+ export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
6
8
 
7
9
  type Schema<TInput, TOutput> = StandardSchemaV1<TInput, TOutput>;
8
10
  type AnySchema = Schema<any, any>;
@@ -10,12 +12,23 @@ type SchemaIssue = StandardSchemaV1.Issue;
10
12
  type InferSchemaInput<T extends AnySchema> = T extends StandardSchemaV1<infer UInput, any> ? UInput : never;
11
13
  type InferSchemaOutput<T extends AnySchema> = T extends StandardSchemaV1<any, infer UOutput> ? UOutput : never;
12
14
  type TypeRest<TInput, TOutput> = [map: (input: TInput) => Promisable<TOutput>] | (IsEqual<TInput, TOutput> extends true ? [] : never);
15
+ /**
16
+ * The schema for things can be trust without validation.
17
+ * If the TInput and TOutput are different, you need pass a map function.
18
+ *
19
+ * @see {@link https://orpc.unnoq.com/docs/procedure#type-utility Type Utility Docs}
20
+ */
13
21
  declare function type<TInput, TOutput = TInput>(...[map]: TypeRest<TInput, TOutput>): Schema<TInput, TOutput>;
14
22
 
15
23
  interface ValidationErrorOptions extends ErrorOptions {
16
24
  message: string;
17
25
  issues: readonly SchemaIssue[];
18
26
  }
27
+ /**
28
+ * This errors usually used for ORPCError.cause when the error is a validation error.
29
+ *
30
+ * @see {@link https://orpc.unnoq.com/docs/advanced/validation-errors Validation Errors Docs}
31
+ */
19
32
  declare class ValidationError extends Error {
20
33
  readonly issues: readonly SchemaIssue[];
21
34
  constructor(options: ValidationErrorOptions);
@@ -41,21 +54,62 @@ declare function mergeMeta<T extends Meta>(meta1: T, meta2: T): T;
41
54
  type InputStructure = 'compact' | 'detailed';
42
55
  type OutputStructure = 'compact' | 'detailed';
43
56
  interface Route {
57
+ /**
58
+ * The HTTP method of the procedure.
59
+ * This option is typically relevant when integrating with OpenAPI.
60
+ *
61
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
62
+ */
44
63
  method?: HTTPMethod;
64
+ /**
65
+ * The HTTP path of the procedure.
66
+ * This option is typically relevant when integrating with OpenAPI.
67
+ *
68
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
69
+ */
45
70
  path?: HTTPPath;
71
+ /**
72
+ * The summary of the procedure.
73
+ * This option is typically relevant when integrating with OpenAPI.
74
+ *
75
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
76
+ */
46
77
  summary?: string;
78
+ /**
79
+ * The description of the procedure.
80
+ * This option is typically relevant when integrating with OpenAPI.
81
+ *
82
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
83
+ */
47
84
  description?: string;
85
+ /**
86
+ * Marks the procedure as deprecated.
87
+ * This option is typically relevant when integrating with OpenAPI.
88
+ *
89
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
90
+ */
48
91
  deprecated?: boolean;
92
+ /**
93
+ * The tags of the procedure.
94
+ * This option is typically relevant when integrating with OpenAPI.
95
+ *
96
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
97
+ */
49
98
  tags?: readonly string[];
50
99
  /**
51
100
  * The status code of the response when the procedure is successful.
101
+ * The status code must be in the 200-399 range.
102
+ * This option is typically relevant when integrating with OpenAPI.
52
103
  *
104
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
53
105
  * @default 200
54
106
  */
55
107
  successStatus?: number;
56
108
  /**
57
109
  * The description of the response when the procedure is successful.
110
+ * This option is typically relevant when integrating with OpenAPI.
58
111
  *
112
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
59
113
  * @default 'OK'
60
114
  */
61
115
  successDescription?: string;
@@ -78,6 +132,7 @@ interface Route {
78
132
  * }
79
133
  * ```
80
134
  *
135
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
81
136
  * @default 'compact'
82
137
  */
83
138
  inputStructure?: InputStructure;
@@ -85,24 +140,33 @@ interface Route {
85
140
  * Determines how the response should be structured based on the output.
86
141
  *
87
142
  * @option 'compact'
88
- * Includes only the body data, encoded directly in the response.
143
+ * The output data is directly returned as the response body.
89
144
  *
90
145
  * @option 'detailed'
91
- * Separates the output into `headers` and `body` fields.
92
- * - `headers`: Custom headers to merge with the response headers.
93
- * - `body`: The response data.
146
+ * Return an object with optional properties:
147
+ * - `status`: The response status (must be in 200-399 range) if not set fallback to `successStatus`.
148
+ * - `headers`: Custom headers to merge with the response headers (`Record<string, string | string[] | undefined>`)
149
+ * - `body`: The response body.
94
150
  *
95
151
  * Example:
96
152
  * ```ts
97
153
  * const output = {
154
+ * status: 201,
98
155
  * headers: { 'x-custom-header': 'value' },
99
156
  * body: { message: 'Hello, world!' },
100
157
  * };
101
158
  * ```
102
159
  *
160
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
103
161
  * @default 'compact'
104
162
  */
105
163
  outputStructure?: OutputStructure;
164
+ /**
165
+ * Override entire auto-generated OpenAPI Operation Object Specification.
166
+ *
167
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata Operation Metadata Docs}
168
+ */
169
+ spec?: OpenAPIV3_1.OperationObject;
106
170
  }
107
171
  declare function mergeRoute(a: Route, b: Route): Route;
108
172
  declare function prefixRoute(route: Route, prefix: HTTPPath): Route;
@@ -122,23 +186,55 @@ interface ContractProcedureDef<TInputSchema extends AnySchema, TOutputSchema ext
122
186
  outputSchema?: TOutputSchema;
123
187
  errorMap: TErrorMap;
124
188
  }
189
+ /**
190
+ * This class represents a contract procedure.
191
+ *
192
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#procedure-contract Contract Procedure Docs}
193
+ */
125
194
  declare class ContractProcedure<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
195
+ /**
196
+ * This property holds the defined options for the contract procedure.
197
+ */
126
198
  '~orpc': ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
127
199
  constructor(def: ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
128
200
  }
129
201
  type AnyContractProcedure = ContractProcedure<any, any, any, any>;
130
202
  declare function isContractProcedure(item: unknown): item is AnyContractProcedure;
131
203
 
204
+ /**
205
+ * Represents a contract router, which defines a hierarchical structure of contract procedures.
206
+ *
207
+ * @info A contract procedure is a contract router too.
208
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
209
+ */
132
210
  type ContractRouter<TMeta extends Meta> = ContractProcedure<any, any, any, TMeta> | {
133
211
  [k: string]: ContractRouter<TMeta>;
134
212
  };
135
213
  type AnyContractRouter = ContractRouter<any>;
214
+ /**
215
+ * Infer all inputs of the contract router.
216
+ *
217
+ * @info A contract procedure is a contract router too.
218
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
219
+ */
136
220
  type InferContractRouterInputs<T extends AnyContractRouter> = T extends ContractProcedure<infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
137
221
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterInputs<T[K]> : never;
138
222
  };
223
+ /**
224
+ * Infer all outputs of the contract router.
225
+ *
226
+ * @info A contract procedure is a contract router too.
227
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
228
+ */
139
229
  type InferContractRouterOutputs<T extends AnyContractRouter> = T extends ContractProcedure<any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
140
230
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterOutputs<T[K]> : never;
141
231
  };
232
+ /**
233
+ * Infer all errors of the contract router.
234
+ *
235
+ * @info A contract procedure is a contract router too.
236
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#utilities Contract Utilities Docs}
237
+ */
142
238
  type InferContractRouterErrorMap<T extends AnyContractRouter> = T extends ContractProcedure<any, any, infer UErrorMap, any> ? UErrorMap : {
143
239
  [K in keyof T]: T[K] extends AnyContractRouter ? InferContractRouterErrorMap<T[K]> : never;
144
240
  }[keyof T];
@@ -152,59 +248,254 @@ interface EnhanceContractRouterOptions<TErrorMap extends ErrorMap> extends Enhan
152
248
  errorMap: TErrorMap;
153
249
  }
154
250
  declare function enhanceContractRouter<T extends AnyContractRouter, TErrorMap extends ErrorMap>(router: T, options: EnhanceContractRouterOptions<TErrorMap>): EnhancedContractRouter<T, TErrorMap>;
251
+ /**
252
+ * Minify a contract router into a smaller object.
253
+ *
254
+ * You should export the result to a JSON file. On the client side, you can import this JSON file and use it as a contract router.
255
+ * This reduces the size of the contract and helps prevent leaking internal details of the router to the client.
256
+ *
257
+ * @see {@link https://orpc.unnoq.com/docs/contract-first/router-to-contract#minify-export-the-contract-router-for-the-client Router to Contract Docs}
258
+ */
259
+ declare function minifyContractRouter(router: AnyContractRouter): AnyContractRouter;
155
260
 
156
261
  interface ContractProcedureBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
262
+ /**
263
+ * Adds type-safe custom errors to the contract.
264
+ * The provided errors are spared-merged with any existing errors in the contract.
265
+ *
266
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
267
+ */
157
268
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
269
+ /**
270
+ * Sets or updates the metadata for the contract.
271
+ * The provided metadata is spared-merged with any existing metadata in the contract.
272
+ *
273
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
274
+ */
158
275
  meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
276
+ /**
277
+ * Sets or updates the route definition for the contract.
278
+ * The provided route is spared-merged with any existing route in the contract.
279
+ * This option is typically relevant when integrating with OpenAPI.
280
+ *
281
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
282
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
283
+ */
159
284
  route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
285
+ /**
286
+ * Defines the input validation schema for the contract.
287
+ *
288
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
289
+ */
160
290
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
291
+ /**
292
+ * Defines the output validation schema for the contract.
293
+ *
294
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
295
+ */
161
296
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
162
297
  }
163
298
  interface ContractProcedureBuilderWithInput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
299
+ /**
300
+ * Adds type-safe custom errors to the contract.
301
+ * The provided errors are spared-merged with any existing errors in the contract.
302
+ *
303
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
304
+ */
164
305
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
306
+ /**
307
+ * Sets or updates the metadata for the contract.
308
+ * The provided metadata is spared-merged with any existing metadata in the contract.
309
+ *
310
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
311
+ */
165
312
  meta(meta: TMeta): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
313
+ /**
314
+ * Sets or updates the route definition for the contract.
315
+ * The provided route is spared-merged with any existing route in the contract.
316
+ * This option is typically relevant when integrating with OpenAPI.
317
+ *
318
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
319
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
320
+ */
166
321
  route(route: Route): ContractProcedureBuilderWithInput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
322
+ /**
323
+ * Defines the output validation schema for the contract.
324
+ *
325
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
326
+ */
167
327
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<TInputSchema, U, TErrorMap, TMeta>;
168
328
  }
169
329
  interface ContractProcedureBuilderWithOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
330
+ /**
331
+ * Adds type-safe custom errors to the contract.
332
+ * The provided errors are spared-merged with any existing errors in the contract.
333
+ *
334
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
335
+ */
170
336
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
337
+ /**
338
+ * Sets or updates the metadata for the contract.
339
+ * The provided metadata is spared-merged with any existing metadata in the contract.
340
+ *
341
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
342
+ */
171
343
  meta(meta: TMeta): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
344
+ /**
345
+ * Sets or updates the route definition for the contract.
346
+ * The provided route is spared-merged with any existing route in the contract.
347
+ * This option is typically relevant when integrating with OpenAPI.
348
+ *
349
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
350
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
351
+ */
172
352
  route(route: Route): ContractProcedureBuilderWithOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
353
+ /**
354
+ * Defines the input validation schema for the contract.
355
+ *
356
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
357
+ */
173
358
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInputOutput<U, TOutputSchema, TErrorMap, TMeta>;
174
359
  }
175
360
  interface ContractProcedureBuilderWithInputOutput<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
361
+ /**
362
+ * Adds type-safe custom errors to the contract.
363
+ * The provided errors are spared-merged with any existing errors in the contract.
364
+ *
365
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
366
+ */
176
367
  errors<U extends ErrorMap>(errors: U): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
368
+ /**
369
+ * Sets or updates the metadata for the contract.
370
+ * The provided metadata is spared-merged with any existing metadata in the contract.
371
+ *
372
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
373
+ */
177
374
  meta(meta: TMeta): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
375
+ /**
376
+ * Sets or updates the route definition for the contract.
377
+ * The provided route is spared-merged with any existing route in the contract.
378
+ * This option is typically relevant when integrating with OpenAPI.
379
+ *
380
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
381
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
382
+ */
178
383
  route(route: Route): ContractProcedureBuilderWithInputOutput<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
179
384
  }
180
385
  interface ContractRouterBuilder<TErrorMap extends ErrorMap, TMeta extends Meta> {
386
+ /**
387
+ * This property holds the defined options for the contract router.
388
+ */
181
389
  '~orpc': EnhanceContractRouterOptions<TErrorMap>;
390
+ /**
391
+ * Adds type-safe custom errors to the contract.
392
+ * The provided errors are spared-merged with any existing errors in the contract.
393
+ *
394
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
395
+ */
182
396
  'errors'<U extends ErrorMap>(errors: U): ContractRouterBuilder<MergedErrorMap<TErrorMap, U>, TMeta>;
397
+ /**
398
+ * Prefixes all procedures in the contract router.
399
+ * The provided prefix is post-appended to any existing router prefix.
400
+ *
401
+ * @note This option does not affect procedures that do not define a path in their route definition.
402
+ *
403
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
404
+ */
183
405
  'prefix'(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
406
+ /**
407
+ * Adds tags to all procedures in the contract router.
408
+ * This helpful when you want to group procedures together in the OpenAPI specification.
409
+ *
410
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
411
+ */
184
412
  'tag'(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
413
+ /**
414
+ * Applies all of the previously defined options to the specified contract router.
415
+ *
416
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
417
+ */
185
418
  'router'<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
186
419
  }
187
420
 
188
421
  interface ContractBuilderDef<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedureDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>, EnhanceContractRouterOptions<TErrorMap> {
189
422
  }
190
423
  declare class ContractBuilder<TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> extends ContractProcedure<TInputSchema, TOutputSchema, TErrorMap, TMeta> {
424
+ /**
425
+ * This property holds the defined options for the contract.
426
+ */
191
427
  '~orpc': ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
192
428
  constructor(def: ContractBuilderDef<TInputSchema, TOutputSchema, TErrorMap, TMeta>);
193
429
  /**
194
- * Reset initial meta
430
+ * Sets or overrides the initial meta.
431
+ *
432
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
195
433
  */
196
434
  $meta<U extends Meta>(initialMeta: U): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, U & Record<never, never>>;
197
435
  /**
198
- * Reset initial route
436
+ * Sets or overrides the initial route.
437
+ * This option is typically relevant when integrating with OpenAPI.
438
+ *
439
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
440
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
199
441
  */
200
442
  $route(initialRoute: Route): ContractBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
443
+ /**
444
+ * Adds type-safe custom errors to the contract.
445
+ * The provided errors are spared-merged with any existing errors in the contract.
446
+ *
447
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
448
+ */
201
449
  errors<U extends ErrorMap>(errors: U): ContractBuilder<TInputSchema, TOutputSchema, MergedErrorMap<TErrorMap, U>, TMeta>;
450
+ /**
451
+ * Sets or updates the metadata for the contract.
452
+ * The provided metadata is spared-merged with any existing metadata in the contract.
453
+ *
454
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
455
+ */
202
456
  meta(meta: TMeta): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
457
+ /**
458
+ * Sets or updates the route definition for the contract.
459
+ * The provided route is spared-merged with any existing route in the contract.
460
+ * This option is typically relevant when integrating with OpenAPI.
461
+ *
462
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
463
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
464
+ */
203
465
  route(route: Route): ContractProcedureBuilder<TInputSchema, TOutputSchema, TErrorMap, TMeta>;
466
+ /**
467
+ * Defines the input validation schema for the contract.
468
+ *
469
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
470
+ */
204
471
  input<U extends AnySchema>(schema: U): ContractProcedureBuilderWithInput<U, TOutputSchema, TErrorMap, TMeta>;
472
+ /**
473
+ * Defines the output validation schema for the contract.
474
+ *
475
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
476
+ */
205
477
  output<U extends AnySchema>(schema: U): ContractProcedureBuilderWithOutput<TInputSchema, U, TErrorMap, TMeta>;
478
+ /**
479
+ * Prefixes all procedures in the contract router.
480
+ * The provided prefix is post-appended to any existing router prefix.
481
+ *
482
+ * @note This option does not affect procedures that do not define a path in their route definition.
483
+ *
484
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
485
+ */
206
486
  prefix(prefix: HTTPPath): ContractRouterBuilder<TErrorMap, TMeta>;
487
+ /**
488
+ * Adds tags to all procedures in the contract router.
489
+ * This helpful when you want to group procedures together in the OpenAPI specification.
490
+ *
491
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
492
+ */
207
493
  tag(...tags: string[]): ContractRouterBuilder<TErrorMap, TMeta>;
494
+ /**
495
+ * Applies all of the previously defined options to the specified contract router.
496
+ *
497
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
498
+ */
208
499
  router<T extends ContractRouter<TMeta>>(router: T): EnhancedContractRouter<T, TErrorMap>;
209
500
  }
210
501
  declare const oc: ContractBuilder<Schema<unknown, unknown>, Schema<unknown, unknown>, Record<never, never>, Record<never, never>>;
@@ -222,13 +513,28 @@ interface EventIteratorSchemaDetails {
222
513
  yields: AnySchema;
223
514
  returns?: AnySchema;
224
515
  }
516
+ /**
517
+ * Define schema for an event iterator.
518
+ *
519
+ * @see {@link https://orpc.unnoq.com/docs/event-iterator#validate-event-iterator Validate Event Iterator Docs}
520
+ */
225
521
  declare function eventIterator<TYieldIn, TYieldOut, TReturnIn = unknown, TReturnOut = unknown>(yields: Schema<TYieldIn, TYieldOut>, returns?: Schema<TReturnIn, TReturnOut>): Schema<AsyncIteratorObject<TYieldIn, TReturnIn, void>, AsyncIteratorObject<TYieldOut, TReturnOut, void>>;
226
522
  declare function getEventIteratorSchemaDetails(schema: AnySchema | undefined): undefined | EventIteratorSchemaDetails;
227
523
 
524
+ /**
525
+ * Help RPCLink automatically send requests using the specified HTTP method in the contract.
526
+ *
527
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link#custom-request-method RPCLink Custom Request Method}
528
+ */
529
+ declare function inferRPCMethodFromContractRouter(contract: AnyContractRouter): (options: unknown, path: readonly string[]) => Exclude<HTTPMethod, 'HEAD'>;
530
+
228
531
  type ContractProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
229
532
 
230
533
  type ContractRouterClient<TRouter extends AnyContractRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ContractProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
231
534
  [K in keyof TRouter]: TRouter[K] extends AnyContractRouter ? ContractRouterClient<TRouter[K], TClientContext> : never;
232
535
  };
233
536
 
234
- export { type AnyContractProcedure, type AnyContractRouter, type AnySchema, ContractBuilder, type ContractBuilderDef, type ContractConfig, ContractProcedure, type ContractProcedureBuilder, type ContractProcedureBuilderWithInput, type ContractProcedureBuilderWithInputOutput, type ContractProcedureBuilderWithOutput, type ContractProcedureClient, type ContractProcedureDef, type ContractRouter, type ContractRouterBuilder, type ContractRouterClient, type EnhanceContractRouterOptions, type EnhanceRouteOptions, type EnhancedContractRouter, type ErrorFromErrorMap, type ErrorMap, type ErrorMapItem, type EventIteratorSchemaDetails, type InferContractRouterErrorMap, type InferContractRouterInputs, type InferContractRouterMeta, type InferContractRouterOutputs, type InferSchemaInput, type InferSchemaOutput, type InputStructure, type MergedErrorMap, type Meta, type ORPCErrorFromErrorMap, type OutputStructure, type Route, type Schema, type SchemaIssue, type TypeRest, ValidationError, type ValidationErrorOptions, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
537
+ declare function isSchemaIssue(issue: unknown): issue is SchemaIssue;
538
+
539
+ export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, inferRPCMethodFromContractRouter, isContractProcedure, isSchemaIssue, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, minifyContractRouter, oc, prefixRoute, type, unshiftTagRoute };
540
+ export type { AnyContractProcedure, AnyContractRouter, AnySchema, ContractBuilderDef, ContractConfig, ContractProcedureBuilder, ContractProcedureBuilderWithInput, ContractProcedureBuilderWithInputOutput, ContractProcedureBuilderWithOutput, ContractProcedureClient, ContractProcedureDef, ContractRouter, ContractRouterBuilder, ContractRouterClient, EnhanceContractRouterOptions, EnhanceRouteOptions, EnhancedContractRouter, ErrorFromErrorMap, ErrorMap, ErrorMapItem, EventIteratorSchemaDetails, InferContractRouterErrorMap, InferContractRouterInputs, InferContractRouterMeta, InferContractRouterOutputs, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, ORPCErrorFromErrorMap, OutputStructure, Route, Schema, SchemaIssue, TypeRest, ValidationErrorOptions };
package/dist/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  import { isORPCErrorStatus, mapEventIterator, ORPCError } from '@orpc/client';
2
2
  export { ORPCError } from '@orpc/client';
3
- import { isAsyncIteratorObject } from '@orpc/shared';
3
+ import { isAsyncIteratorObject, get, isTypescriptObject, isPropertyKey } from '@orpc/shared';
4
4
 
5
5
  class ValidationError extends Error {
6
6
  issues;
@@ -18,6 +18,9 @@ function mergeMeta(meta1, meta2) {
18
18
  }
19
19
 
20
20
  class ContractProcedure {
21
+ /**
22
+ * This property holds the defined options for the contract procedure.
23
+ */
21
24
  "~orpc";
22
25
  constructor(def) {
23
26
  if (def.route?.successStatus && isORPCErrorStatus(def.route.successStatus)) {
@@ -100,6 +103,23 @@ function enhanceContractRouter(router, options) {
100
103
  }
101
104
  return enhanced;
102
105
  }
106
+ function minifyContractRouter(router) {
107
+ if (isContractProcedure(router)) {
108
+ const procedure = {
109
+ "~orpc": {
110
+ errorMap: {},
111
+ meta: router["~orpc"].meta,
112
+ route: router["~orpc"].route
113
+ }
114
+ };
115
+ return procedure;
116
+ }
117
+ const json = {};
118
+ for (const key in router) {
119
+ json[key] = minifyContractRouter(router[key]);
120
+ }
121
+ return json;
122
+ }
103
123
 
104
124
  class ContractBuilder extends ContractProcedure {
105
125
  constructor(def) {
@@ -108,7 +128,9 @@ class ContractBuilder extends ContractProcedure {
108
128
  this["~orpc"].tags = def.tags;
109
129
  }
110
130
  /**
111
- * Reset initial meta
131
+ * Sets or overrides the initial meta.
132
+ *
133
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
112
134
  */
113
135
  $meta(initialMeta) {
114
136
  return new ContractBuilder({
@@ -117,7 +139,11 @@ class ContractBuilder extends ContractProcedure {
117
139
  });
118
140
  }
119
141
  /**
120
- * Reset initial route
142
+ * Sets or overrides the initial route.
143
+ * This option is typically relevant when integrating with OpenAPI.
144
+ *
145
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
146
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
121
147
  */
122
148
  $route(initialRoute) {
123
149
  return new ContractBuilder({
@@ -125,48 +151,97 @@ class ContractBuilder extends ContractProcedure {
125
151
  route: initialRoute
126
152
  });
127
153
  }
154
+ /**
155
+ * Adds type-safe custom errors to the contract.
156
+ * The provided errors are spared-merged with any existing errors in the contract.
157
+ *
158
+ * @see {@link https://orpc.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
159
+ */
128
160
  errors(errors) {
129
161
  return new ContractBuilder({
130
162
  ...this["~orpc"],
131
163
  errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
132
164
  });
133
165
  }
166
+ /**
167
+ * Sets or updates the metadata for the contract.
168
+ * The provided metadata is spared-merged with any existing metadata in the contract.
169
+ *
170
+ * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
171
+ */
134
172
  meta(meta) {
135
173
  return new ContractBuilder({
136
174
  ...this["~orpc"],
137
175
  meta: mergeMeta(this["~orpc"].meta, meta)
138
176
  });
139
177
  }
178
+ /**
179
+ * Sets or updates the route definition for the contract.
180
+ * The provided route is spared-merged with any existing route in the contract.
181
+ * This option is typically relevant when integrating with OpenAPI.
182
+ *
183
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
184
+ * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
185
+ */
140
186
  route(route) {
141
187
  return new ContractBuilder({
142
188
  ...this["~orpc"],
143
189
  route: mergeRoute(this["~orpc"].route, route)
144
190
  });
145
191
  }
192
+ /**
193
+ * Defines the input validation schema for the contract.
194
+ *
195
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
196
+ */
146
197
  input(schema) {
147
198
  return new ContractBuilder({
148
199
  ...this["~orpc"],
149
200
  inputSchema: schema
150
201
  });
151
202
  }
203
+ /**
204
+ * Defines the output validation schema for the contract.
205
+ *
206
+ * @see {@link https://orpc.unnoq.com/docs/procedure#input-output-validation Output Validation Docs}
207
+ */
152
208
  output(schema) {
153
209
  return new ContractBuilder({
154
210
  ...this["~orpc"],
155
211
  outputSchema: schema
156
212
  });
157
213
  }
214
+ /**
215
+ * Prefixes all procedures in the contract router.
216
+ * The provided prefix is post-appended to any existing router prefix.
217
+ *
218
+ * @note This option does not affect procedures that do not define a path in their route definition.
219
+ *
220
+ * @see {@link https://orpc.unnoq.com/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
221
+ */
158
222
  prefix(prefix) {
159
223
  return new ContractBuilder({
160
224
  ...this["~orpc"],
161
225
  prefix: mergePrefix(this["~orpc"].prefix, prefix)
162
226
  });
163
227
  }
228
+ /**
229
+ * Adds tags to all procedures in the contract router.
230
+ * This helpful when you want to group procedures together in the OpenAPI specification.
231
+ *
232
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
233
+ */
164
234
  tag(...tags) {
165
235
  return new ContractBuilder({
166
236
  ...this["~orpc"],
167
237
  tags: mergeTags(this["~orpc"].tags, tags)
168
238
  });
169
239
  }
240
+ /**
241
+ * Applies all of the previously defined options to the specified contract router.
242
+ *
243
+ * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
244
+ */
170
245
  router(router) {
171
246
  return enhanceContractRouter(router, this["~orpc"]);
172
247
  }
@@ -234,6 +309,19 @@ function getEventIteratorSchemaDetails(schema) {
234
309
  return schema["~standard"][EVENT_ITERATOR_DETAILS_SYMBOL];
235
310
  }
236
311
 
312
+ function inferRPCMethodFromContractRouter(contract) {
313
+ return (_, path) => {
314
+ const procedure = get(contract, path);
315
+ if (!isContractProcedure(procedure)) {
316
+ throw new Error(
317
+ `[inferRPCMethodFromContractRouter] No valid procedure found at path "${path.join(".")}". This may happen when the contract router is not properly configured.`
318
+ );
319
+ }
320
+ const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
321
+ return method === "HEAD" ? "GET" : method;
322
+ };
323
+ }
324
+
237
325
  function type(...[map]) {
238
326
  return {
239
327
  "~standard": {
@@ -249,4 +337,19 @@ function type(...[map]) {
249
337
  };
250
338
  }
251
339
 
252
- export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
340
+ function isSchemaIssue(issue) {
341
+ if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
342
+ return false;
343
+ }
344
+ if (issue.path !== void 0) {
345
+ if (!Array.isArray(issue.path)) {
346
+ return false;
347
+ }
348
+ if (!issue.path.every((segment) => isPropertyKey(segment) || isTypescriptObject(segment) && isPropertyKey(segment.key))) {
349
+ return false;
350
+ }
351
+ }
352
+ return true;
353
+ }
354
+
355
+ export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, inferRPCMethodFromContractRouter, isContractProcedure, isSchemaIssue, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, minifyContractRouter, oc, prefixRoute, type, unshiftTagRoute };
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.ee46dab",
4
+ "version": "0.0.0-next.ee5598c",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -25,14 +25,14 @@
25
25
  ],
26
26
  "dependencies": {
27
27
  "@standard-schema/spec": "^1.0.0",
28
- "@orpc/shared": "0.0.0-next.ee46dab",
29
- "@orpc/client": "0.0.0-next.ee46dab",
30
- "@orpc/standard-server": "0.0.0-next.ee46dab"
28
+ "openapi-types": "^12.1.3",
29
+ "@orpc/client": "0.0.0-next.ee5598c",
30
+ "@orpc/shared": "0.0.0-next.ee5598c"
31
31
  },
32
32
  "devDependencies": {
33
- "arktype": "2.0.0-rc.26",
34
- "valibot": "1.0.0-beta.9",
35
- "zod": "^3.24.2"
33
+ "arktype": "2.1.20",
34
+ "valibot": "^1.1.0",
35
+ "zod": "^3.25.76"
36
36
  },
37
37
  "scripts": {
38
38
  "build": "unbuild",