@orpc/zod 1.14.5 → 2.0.0-beta.1
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 +75 -150
- package/dist/index.d.mts +11 -87
- package/dist/index.d.ts +11 -87
- package/dist/index.mjs +53 -857
- package/package.json +7 -17
- package/dist/zod4/index.d.mts +0 -314
- package/dist/zod4/index.d.ts +0 -314
- package/dist/zod4/index.mjs +0 -698
package/README.md
CHANGED
|
@@ -1,8 +1,4 @@
|
|
|
1
|
-
<
|
|
2
|
-
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
|
-
</div>
|
|
4
|
-
|
|
5
|
-
<h1></h1>
|
|
1
|
+
<h1 align="center">oRPC - Typesafe APIs Made Simple 🪄</h1>
|
|
6
2
|
|
|
7
3
|
<div align="center">
|
|
8
4
|
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
@@ -22,119 +18,46 @@
|
|
|
22
18
|
</a>
|
|
23
19
|
</div>
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
## Documentation
|
|
22
|
+
|
|
23
|
+
You can read the documentation [here](https://orpc.dev).
|
|
26
24
|
|
|
27
|
-
|
|
25
|
+
## Packages
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
**Core**
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define type-safe contracts for your API.
|
|
30
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Implement your API or contract on the server.
|
|
31
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API from the client with full type safety.
|
|
32
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Bring OpenAPI compatibility to your APIs.
|
|
32
33
|
|
|
33
|
-
|
|
34
|
-
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
35
|
-
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
36
|
-
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
37
|
-
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
38
|
-
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
39
|
-
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
40
|
-
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
41
|
-
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
|
42
|
-
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
43
|
-
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
44
|
-
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
34
|
+
**Schema validation**
|
|
45
35
|
|
|
46
|
-
|
|
36
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
37
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
38
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
47
39
|
|
|
48
|
-
|
|
40
|
+
**Framework & ecosystem integrations**
|
|
49
41
|
|
|
50
|
-
|
|
42
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/react): Use oRPC with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
43
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
44
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
45
|
+
|
|
46
|
+
**Built-in features**
|
|
47
|
+
|
|
48
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub.
|
|
49
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting.
|
|
50
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
51
51
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
- [@orpc/
|
|
55
|
-
- [@orpc/
|
|
56
|
-
- [@orpc/
|
|
57
|
-
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
58
|
-
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
59
|
-
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
60
|
-
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
|
61
|
-
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
-
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
|
-
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
|
-
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
|
-
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
66
|
-
|
|
67
|
-
## `@orpc/zod`
|
|
68
|
-
|
|
69
|
-
More schemas that [Zod](https://zod.dev/) doesn't support yet, and provides `ZodToJsonSchemaConverter` for generating OpenAPI specs.
|
|
70
|
-
|
|
71
|
-
### More Schemas
|
|
72
|
-
|
|
73
|
-
- `oz.url`: Zod schema for [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) instance.
|
|
74
|
-
- `oz.blob`: Zod schema for [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) instance.
|
|
75
|
-
- `oz.file`: Zod schema for [File](https://developer.mozilla.org/en-US/docs/Web/API/File) instance.
|
|
76
|
-
- `oz.regexp`: Zod schema for [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) instance.
|
|
77
|
-
|
|
78
|
-
```ts
|
|
79
|
-
import { oz } from '@orpc/zod'
|
|
80
|
-
import { z } from 'zod/v3'
|
|
81
|
-
|
|
82
|
-
const Example = z.object({
|
|
83
|
-
url: oz.url(),
|
|
84
|
-
blob: oz.blob(),
|
|
85
|
-
file: oz.file().type('image/png'),
|
|
86
|
-
regexp: oz.regexp(),
|
|
87
|
-
})
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
### Generate OpenAPI Spec
|
|
91
|
-
|
|
92
|
-
```ts
|
|
93
|
-
import { OpenAPIGenerator } from '@orpc/openapi'
|
|
94
|
-
import { ZodToJsonSchemaConverter } from '@orpc/zod/zod4'
|
|
95
|
-
|
|
96
|
-
const openAPIGenerator = new OpenAPIGenerator({
|
|
97
|
-
schemaConverters: [new ZodToJsonSchemaConverter()],
|
|
98
|
-
})
|
|
99
|
-
|
|
100
|
-
const specFromContract = await openAPIGenerator.generate(contract, {
|
|
101
|
-
info: {
|
|
102
|
-
title: 'My App',
|
|
103
|
-
version: '0.0.0',
|
|
104
|
-
},
|
|
105
|
-
})
|
|
106
|
-
|
|
107
|
-
const specFromRouter = await openAPIGenerator.generate(router, {
|
|
108
|
-
info: {
|
|
109
|
-
title: 'My App',
|
|
110
|
-
version: '0.0.0',
|
|
111
|
-
},
|
|
112
|
-
})
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
### Extending the Specification
|
|
116
|
-
|
|
117
|
-
```ts
|
|
118
|
-
import { oz } from '@orpc/zod'
|
|
119
|
-
import * as z from 'zod'
|
|
120
|
-
|
|
121
|
-
const InputSchema = oz.openapi(
|
|
122
|
-
z.object({
|
|
123
|
-
name: z.string(),
|
|
124
|
-
}),
|
|
125
|
-
{
|
|
126
|
-
examples: [
|
|
127
|
-
{ name: 'Earth' },
|
|
128
|
-
{ name: 'Mars' },
|
|
129
|
-
],
|
|
130
|
-
// additional options...
|
|
131
|
-
}
|
|
132
|
-
)
|
|
133
|
-
```
|
|
52
|
+
**Observability**
|
|
53
|
+
|
|
54
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Instrument your API with [OpenTelemetry](https://opentelemetry.io/).
|
|
55
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Log with [Pino](https://getpino.io/).
|
|
56
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Log with [Evlog](https://evlog.dev/).
|
|
134
57
|
|
|
135
58
|
## Sponsors
|
|
136
59
|
|
|
137
|
-
|
|
60
|
+
Like what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh). Every bit helps! 🚀
|
|
138
61
|
|
|
139
62
|
### 🏆 Platinum Sponsor
|
|
140
63
|
|
|
@@ -152,19 +75,11 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
152
75
|
</tr>
|
|
153
76
|
</table>
|
|
154
77
|
|
|
155
|
-
### 🥉 Bronze Sponsor
|
|
156
|
-
|
|
157
|
-
<table>
|
|
158
|
-
<tr>
|
|
159
|
-
<td align="center"><a href="https://plancraft.com/?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="167" alt="plancraft"/><br />plancraft</a></td>
|
|
160
|
-
</tr>
|
|
161
|
-
</table>
|
|
162
|
-
|
|
163
78
|
### Generous Sponsors
|
|
164
79
|
|
|
165
80
|
<table>
|
|
166
81
|
<tr>
|
|
167
|
-
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="noopener" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="
|
|
82
|
+
<td align="center"><a href="https://github.com/ln-markets?ref=orpc" target="_blank" rel="noopener" title="LN Markets"><img src="https://avatars.githubusercontent.com/u/70597625?v=4" width="167" alt="LN Markets"/><br />LN Markets</a></td>
|
|
168
83
|
</tr>
|
|
169
84
|
</table>
|
|
170
85
|
|
|
@@ -172,27 +87,26 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
172
87
|
|
|
173
88
|
<table>
|
|
174
89
|
<tr>
|
|
175
|
-
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="
|
|
176
|
-
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="
|
|
177
|
-
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="
|
|
178
|
-
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="
|
|
179
|
-
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="
|
|
180
|
-
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="
|
|
181
|
-
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="119" alt="David Cramer"/><br />David Cramer</a></td>
|
|
90
|
+
<td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="139" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
91
|
+
<td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&v=4" width="139" alt="nk"/><br />nk</a></td>
|
|
92
|
+
<td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="139" alt="supastarter"/><br />supastarter</a></td>
|
|
93
|
+
<td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&v=4" width="139" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
94
|
+
<td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&v=4" width="139" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
95
|
+
<td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
182
96
|
</tr>
|
|
183
97
|
<tr>
|
|
184
|
-
<td align="center"><a href="https://github.com/
|
|
185
|
-
<td align="center"><a href="https://github.com/
|
|
186
|
-
<td align="center"><a href="https://github.com/
|
|
187
|
-
<td align="center"><a href="https://github.com/
|
|
188
|
-
<td align="center"><a href="https://github.com/
|
|
189
|
-
<td align="center"><a href="https://github.com/
|
|
190
|
-
<td align="center"><a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="119" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
98
|
+
<td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="139" alt="David Cramer"/><br />David Cramer</a></td>
|
|
99
|
+
<td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
100
|
+
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
101
|
+
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
102
|
+
<td align="center"><a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="139" alt="Andrew Peters"/><br />Andrew Peters</a></td>
|
|
103
|
+
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
191
104
|
</tr>
|
|
192
105
|
<tr>
|
|
193
|
-
<td align="center"><a href="https://github.com/
|
|
194
|
-
<td align="center"><a href="https://github.com/
|
|
195
|
-
<td align="center"><a href="https://github.com/
|
|
106
|
+
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
|
|
107
|
+
<td align="center"><a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="139" alt="Peter Adam"/><br />Peter Adam</a></td>
|
|
108
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
109
|
+
<td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="139" alt="shota"/><br />shota</a></td>
|
|
196
110
|
</tr>
|
|
197
111
|
</table>
|
|
198
112
|
|
|
@@ -200,27 +114,27 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
200
114
|
|
|
201
115
|
<table>
|
|
202
116
|
<tr>
|
|
203
|
-
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="
|
|
204
|
-
<td align="center"><a href="https://github.com/
|
|
205
|
-
<td align="center"><a href="https://github.com/
|
|
206
|
-
<td align="center"><a href="https://github.com/
|
|
207
|
-
<td align="center"><a href="https://github.com/
|
|
208
|
-
<td align="center"><a href="https://github.com/
|
|
209
|
-
<td align="center"><a href="https://github.com/
|
|
210
|
-
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="104" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
117
|
+
<td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&v=4" width="119" alt="David Walsh"/><br />David Walsh</a></td>
|
|
118
|
+
<td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&v=4" width="119" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
119
|
+
<td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="noopener" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="119" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
120
|
+
<td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&v=4" width="119" alt="soonoo"/><br />soonoo</a></td>
|
|
121
|
+
<td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&v=4" width="119" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
122
|
+
<td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&v=4" width="119" alt="Denis"/><br />Denis</a></td>
|
|
123
|
+
<td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
211
124
|
</tr>
|
|
212
125
|
<tr>
|
|
213
|
-
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="
|
|
214
|
-
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="
|
|
215
|
-
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="
|
|
216
|
-
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="
|
|
217
|
-
<td align="center"><a href="https://github.com/
|
|
218
|
-
<td align="center"><a href="https://github.com/
|
|
219
|
-
<td align="center"><a href="https://github.com/
|
|
220
|
-
<td align="center"><a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="nattstack"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="104" alt="nattstack"/><br />nattstack</a></td>
|
|
126
|
+
<td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&v=4" width="119" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
127
|
+
<td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&v=4" width="119" alt="Sam"/><br />Sam</a></td>
|
|
128
|
+
<td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&v=4" width="119" alt="Titoine"/><br />Titoine</a></td>
|
|
129
|
+
<td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
130
|
+
<td align="center"><a href="https://github.com/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
|
|
131
|
+
<td align="center"><a href="https://github.com/ldub?ref=orpc" target="_blank" rel="noopener" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
|
|
132
|
+
<td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
|
|
221
133
|
</tr>
|
|
222
134
|
<tr>
|
|
223
|
-
<td align="center"><a href="https://github.com/
|
|
135
|
+
<td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&v=4" width="119" alt="Alex"/><br />Alex</a></td>
|
|
136
|
+
<td align="center"><a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="nattstack"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="119" alt="nattstack"/><br />nattstack</a></td>
|
|
137
|
+
<td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
224
138
|
</tr>
|
|
225
139
|
</table>
|
|
226
140
|
|
|
@@ -254,10 +168,21 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
254
168
|
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
255
169
|
<a href="https://github.com/NovakAnton?ref=orpc" target="_blank" rel="noopener" title="Novak Antonijevic"><img src="https://avatars.githubusercontent.com/u/157126729?u=ae49fa22292d55c0434ff0ca008206155b18663b&v=4" width="32" height="32" alt="Novak Antonijevic" /></a>
|
|
256
170
|
<a href="https://github.com/laduniestu?ref=orpc" target="_blank" rel="noopener" title="Laduni Estu Syalwa"><img src="https://avatars.githubusercontent.com/u/44757637?u=a2fc1ea8f7d827a96721176f79d30592d1c48059&v=4" width="32" height="32" alt="Laduni Estu Syalwa" /></a>
|
|
171
|
+
<a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="noopener" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&v=4" width="32" height="32" alt="Chen, Zhi-Yuan" /></a>
|
|
257
172
|
<a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="noopener" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&v=4" width="32" height="32" alt="Illarion Koperski" /></a>
|
|
173
|
+
<a href="https://github.com/steelbrain?ref=orpc" target="_blank" rel="noopener" title="Anees Iqbal"><img src="https://avatars.githubusercontent.com/u/4278113?u=22b80b5399eed68ac76cd58b02961b0481f1db11&v=4" width="32" height="32" alt="Anees Iqbal" /></a>
|
|
258
174
|
<a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="noopener" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&v=4" width="32" height="32" alt="Sefa Eyeoglu" /></a>
|
|
175
|
+
<a href="https://github.com/ChromeGG?ref=orpc" target="_blank" rel="noopener" title="Adam Tkaczyk"><img src="https://avatars.githubusercontent.com/u/39050595?u=a58ca6042a6950e94e6e92442db76ef584279bc0&v=4" width="32" height="32" alt="Adam Tkaczyk" /></a>
|
|
176
|
+
<a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
|
|
259
177
|
</p>
|
|
260
178
|
|
|
179
|
+
## References
|
|
180
|
+
|
|
181
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
182
|
+
|
|
183
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
184
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
185
|
+
|
|
261
186
|
## License
|
|
262
187
|
|
|
263
188
|
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,91 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { Context } from '@orpc/server';
|
|
4
|
-
import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
5
|
-
import { AnySchema } from '@orpc/contract';
|
|
1
|
+
import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
2
|
+
import { ToJSONSchemaParams } from 'zod/v4/core';
|
|
6
3
|
|
|
7
|
-
|
|
8
|
-
strategy: 'input' | 'output' | 'both';
|
|
9
|
-
}): Exclude<JSONSchema, boolean> | undefined;
|
|
10
|
-
declare function customJsonSchema<T extends ZodTypeAny, TStrategy extends 'input' | 'output' | 'both' = 'both'>(schema: T, custom: Exclude<JSONSchema<TStrategy extends 'input' ? input<T> : TStrategy extends 'output' ? output<T> : input<T> & output<T>>, boolean>, options?: {
|
|
11
|
-
strategy?: TStrategy;
|
|
12
|
-
}): T;
|
|
13
|
-
|
|
14
|
-
type CustomParams = CustomErrorParams & {
|
|
15
|
-
fatal?: boolean;
|
|
16
|
-
};
|
|
17
|
-
type CustomZodDef = {
|
|
18
|
-
type: 'blob' | 'regexp' | 'url';
|
|
19
|
-
} | {
|
|
20
|
-
type: 'file';
|
|
21
|
-
mimeType?: string;
|
|
22
|
-
};
|
|
23
|
-
declare function setCustomZodDef<T extends ZodTypeDef>(def: T, custom: CustomZodDef): void;
|
|
24
|
-
declare function getCustomZodDef(def: ZodTypeDef): CustomZodDef | undefined;
|
|
25
|
-
declare function composeParams<T = unknown>(defaultMessage: (input: T) => string, params: undefined | string | CustomParams | ((input: T) => CustomParams)): (input: T) => CustomParams;
|
|
26
|
-
|
|
27
|
-
declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Blob, ZodTypeDef, Blob>;
|
|
28
|
-
|
|
29
|
-
declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<File, ZodTypeDef, File> & {
|
|
30
|
-
type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<File, ZodTypeDef, File>, File, File>;
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
declare function regexp(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<RegExp, ZodTypeDef, RegExp>;
|
|
34
|
-
|
|
35
|
-
declare function url(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<URL, ZodTypeDef, URL>;
|
|
36
|
-
|
|
37
|
-
declare class ZodSmartCoercionPlugin<TContext extends Context> implements StandardHandlerPlugin<TContext> {
|
|
38
|
-
init(options: StandardHandlerOptions<TContext>): void;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
interface ZodToJsonSchemaOptions {
|
|
42
|
-
/**
|
|
43
|
-
* Max depth of lazy type
|
|
44
|
-
*
|
|
45
|
-
* Used `{}` when exceed max depth
|
|
46
|
-
*
|
|
47
|
-
* @default 3
|
|
48
|
-
*/
|
|
49
|
-
maxLazyDepth?: number;
|
|
50
|
-
/**
|
|
51
|
-
* Max depth of nested types
|
|
52
|
-
*
|
|
53
|
-
* Used anyJsonSchema (`{}`) when exceed max depth
|
|
54
|
-
*
|
|
55
|
-
* @default 10
|
|
56
|
-
*/
|
|
57
|
-
maxStructureDepth?: number;
|
|
58
|
-
/**
|
|
59
|
-
* The schema to be used to represent the any | unknown type.
|
|
60
|
-
*
|
|
61
|
-
* @default { }
|
|
62
|
-
*/
|
|
63
|
-
anyJsonSchema?: Exclude<JSONSchema, boolean>;
|
|
64
|
-
/**
|
|
65
|
-
* The schema to be used when the Zod schema is unsupported.
|
|
66
|
-
*
|
|
67
|
-
* @default { not: {} }
|
|
68
|
-
*/
|
|
69
|
-
unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
|
|
4
|
+
interface ZodToJsonSchemaConverterOptions extends Omit<ToJSONSchemaParams, 'target' | 'io'> {
|
|
70
5
|
}
|
|
71
|
-
declare class ZodToJsonSchemaConverter implements
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
private
|
|
77
|
-
constructor(options?: ZodToJsonSchemaOptions);
|
|
78
|
-
condition(schema: AnySchema | undefined): boolean;
|
|
79
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean, structureDepth?: number): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
|
|
6
|
+
declare class ZodToJsonSchemaConverter implements JsonSchemaConverter {
|
|
7
|
+
private readonly options;
|
|
8
|
+
constructor(options?: ZodToJsonSchemaConverterOptions);
|
|
9
|
+
condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
|
|
10
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
11
|
+
private convertZod;
|
|
80
12
|
}
|
|
81
13
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
blob: typeof blob;
|
|
85
|
-
url: typeof url;
|
|
86
|
-
regexp: typeof regexp;
|
|
87
|
-
openapi: typeof customJsonSchema;
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
|
|
91
|
-
export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };
|
|
14
|
+
export { ZodToJsonSchemaConverter };
|
|
15
|
+
export type { ZodToJsonSchemaConverterOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,91 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { Context } from '@orpc/server';
|
|
4
|
-
import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
5
|
-
import { AnySchema } from '@orpc/contract';
|
|
1
|
+
import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
2
|
+
import { ToJSONSchemaParams } from 'zod/v4/core';
|
|
6
3
|
|
|
7
|
-
|
|
8
|
-
strategy: 'input' | 'output' | 'both';
|
|
9
|
-
}): Exclude<JSONSchema, boolean> | undefined;
|
|
10
|
-
declare function customJsonSchema<T extends ZodTypeAny, TStrategy extends 'input' | 'output' | 'both' = 'both'>(schema: T, custom: Exclude<JSONSchema<TStrategy extends 'input' ? input<T> : TStrategy extends 'output' ? output<T> : input<T> & output<T>>, boolean>, options?: {
|
|
11
|
-
strategy?: TStrategy;
|
|
12
|
-
}): T;
|
|
13
|
-
|
|
14
|
-
type CustomParams = CustomErrorParams & {
|
|
15
|
-
fatal?: boolean;
|
|
16
|
-
};
|
|
17
|
-
type CustomZodDef = {
|
|
18
|
-
type: 'blob' | 'regexp' | 'url';
|
|
19
|
-
} | {
|
|
20
|
-
type: 'file';
|
|
21
|
-
mimeType?: string;
|
|
22
|
-
};
|
|
23
|
-
declare function setCustomZodDef<T extends ZodTypeDef>(def: T, custom: CustomZodDef): void;
|
|
24
|
-
declare function getCustomZodDef(def: ZodTypeDef): CustomZodDef | undefined;
|
|
25
|
-
declare function composeParams<T = unknown>(defaultMessage: (input: T) => string, params: undefined | string | CustomParams | ((input: T) => CustomParams)): (input: T) => CustomParams;
|
|
26
|
-
|
|
27
|
-
declare function blob(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<Blob, ZodTypeDef, Blob>;
|
|
28
|
-
|
|
29
|
-
declare function file(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<File, ZodTypeDef, File> & {
|
|
30
|
-
type(mimeType: string, params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodEffects<ZodType<File, ZodTypeDef, File>, File, File>;
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
declare function regexp(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<RegExp, ZodTypeDef, RegExp>;
|
|
34
|
-
|
|
35
|
-
declare function url(params?: string | CustomParams | ((input: unknown) => CustomParams)): ZodType<URL, ZodTypeDef, URL>;
|
|
36
|
-
|
|
37
|
-
declare class ZodSmartCoercionPlugin<TContext extends Context> implements StandardHandlerPlugin<TContext> {
|
|
38
|
-
init(options: StandardHandlerOptions<TContext>): void;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
interface ZodToJsonSchemaOptions {
|
|
42
|
-
/**
|
|
43
|
-
* Max depth of lazy type
|
|
44
|
-
*
|
|
45
|
-
* Used `{}` when exceed max depth
|
|
46
|
-
*
|
|
47
|
-
* @default 3
|
|
48
|
-
*/
|
|
49
|
-
maxLazyDepth?: number;
|
|
50
|
-
/**
|
|
51
|
-
* Max depth of nested types
|
|
52
|
-
*
|
|
53
|
-
* Used anyJsonSchema (`{}`) when exceed max depth
|
|
54
|
-
*
|
|
55
|
-
* @default 10
|
|
56
|
-
*/
|
|
57
|
-
maxStructureDepth?: number;
|
|
58
|
-
/**
|
|
59
|
-
* The schema to be used to represent the any | unknown type.
|
|
60
|
-
*
|
|
61
|
-
* @default { }
|
|
62
|
-
*/
|
|
63
|
-
anyJsonSchema?: Exclude<JSONSchema, boolean>;
|
|
64
|
-
/**
|
|
65
|
-
* The schema to be used when the Zod schema is unsupported.
|
|
66
|
-
*
|
|
67
|
-
* @default { not: {} }
|
|
68
|
-
*/
|
|
69
|
-
unsupportedJsonSchema?: Exclude<JSONSchema, boolean>;
|
|
4
|
+
interface ZodToJsonSchemaConverterOptions extends Omit<ToJSONSchemaParams, 'target' | 'io'> {
|
|
70
5
|
}
|
|
71
|
-
declare class ZodToJsonSchemaConverter implements
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
private
|
|
77
|
-
constructor(options?: ZodToJsonSchemaOptions);
|
|
78
|
-
condition(schema: AnySchema | undefined): boolean;
|
|
79
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions, lazyDepth?: number, isHandledCustomJSONSchema?: boolean, isHandledZodDescription?: boolean, structureDepth?: number): [required: boolean, jsonSchema: Exclude<JSONSchema, boolean>];
|
|
6
|
+
declare class ZodToJsonSchemaConverter implements JsonSchemaConverter {
|
|
7
|
+
private readonly options;
|
|
8
|
+
constructor(options?: ZodToJsonSchemaConverterOptions);
|
|
9
|
+
condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
|
|
10
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
11
|
+
private convertZod;
|
|
80
12
|
}
|
|
81
13
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
blob: typeof blob;
|
|
85
|
-
url: typeof url;
|
|
86
|
-
regexp: typeof regexp;
|
|
87
|
-
openapi: typeof customJsonSchema;
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
export { ZodSmartCoercionPlugin, ZodToJsonSchemaConverter, blob, composeParams, customJsonSchema, file, getCustomJsonSchema, getCustomZodDef, oz, regexp, setCustomZodDef, url };
|
|
91
|
-
export type { CustomParams, CustomZodDef, ZodToJsonSchemaOptions };
|
|
14
|
+
export { ZodToJsonSchemaConverter };
|
|
15
|
+
export type { ZodToJsonSchemaConverterOptions };
|