@orpc/valibot 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 -113
- package/dist/index.d.mts +10 -10
- package/dist/index.d.ts +10 -10
- package/dist/index.mjs +59 -13
- package/package.json +7 -8
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,82 +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/valibot`
|
|
68
|
-
|
|
69
|
-
Provides `ValibotToJsonSchemaConverter` for generating OpenAPI specs from [Valibot](https://valibot.dev/).
|
|
70
|
-
|
|
71
|
-
### Generate OpenAPI Spec
|
|
72
|
-
|
|
73
|
-
```ts
|
|
74
|
-
import { OpenAPIGenerator } from '@orpc/openapi'
|
|
75
|
-
import { experimental_ValibotToJsonSchemaConverter as ValibotToJsonSchemaConverter } from '@orpc/valibot'
|
|
76
|
-
|
|
77
|
-
const openAPIGenerator = new OpenAPIGenerator({
|
|
78
|
-
schemaConverters: [
|
|
79
|
-
new ValibotToJsonSchemaConverter()
|
|
80
|
-
],
|
|
81
|
-
})
|
|
82
|
-
|
|
83
|
-
const specFromContract = await openAPIGenerator.generate(contract, {
|
|
84
|
-
info: {
|
|
85
|
-
title: 'My App',
|
|
86
|
-
version: '0.0.0',
|
|
87
|
-
},
|
|
88
|
-
})
|
|
89
|
-
|
|
90
|
-
const specFromRouter = await openAPIGenerator.generate(router, {
|
|
91
|
-
info: {
|
|
92
|
-
title: 'My App',
|
|
93
|
-
version: '0.0.0',
|
|
94
|
-
},
|
|
95
|
-
})
|
|
96
|
-
```
|
|
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/).
|
|
97
57
|
|
|
98
58
|
## Sponsors
|
|
99
59
|
|
|
100
|
-
|
|
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! 🚀
|
|
101
61
|
|
|
102
62
|
### 🏆 Platinum Sponsor
|
|
103
63
|
|
|
@@ -115,19 +75,11 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
115
75
|
</tr>
|
|
116
76
|
</table>
|
|
117
77
|
|
|
118
|
-
### 🥉 Bronze Sponsor
|
|
119
|
-
|
|
120
|
-
<table>
|
|
121
|
-
<tr>
|
|
122
|
-
<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>
|
|
123
|
-
</tr>
|
|
124
|
-
</table>
|
|
125
|
-
|
|
126
78
|
### Generous Sponsors
|
|
127
79
|
|
|
128
80
|
<table>
|
|
129
81
|
<tr>
|
|
130
|
-
<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>
|
|
131
83
|
</tr>
|
|
132
84
|
</table>
|
|
133
85
|
|
|
@@ -135,27 +87,26 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
135
87
|
|
|
136
88
|
<table>
|
|
137
89
|
<tr>
|
|
138
|
-
<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
|
-
<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="
|
|
140
|
-
<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="
|
|
141
|
-
<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="
|
|
142
|
-
<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="
|
|
143
|
-
<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="
|
|
144
|
-
<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>
|
|
145
96
|
</tr>
|
|
146
97
|
<tr>
|
|
147
|
-
<td align="center"><a href="https://github.com/
|
|
148
|
-
<td align="center"><a href="https://github.com/
|
|
149
|
-
<td align="center"><a href="https://github.com/
|
|
150
|
-
<td align="center"><a href="https://github.com/
|
|
151
|
-
<td align="center"><a href="https://github.com/
|
|
152
|
-
<td align="center"><a href="https://github.com/
|
|
153
|
-
<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>
|
|
154
104
|
</tr>
|
|
155
105
|
<tr>
|
|
156
|
-
<td align="center"><a href="https://github.com/
|
|
157
|
-
<td align="center"><a href="https://github.com/
|
|
158
|
-
<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>
|
|
159
110
|
</tr>
|
|
160
111
|
</table>
|
|
161
112
|
|
|
@@ -163,27 +114,27 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
163
114
|
|
|
164
115
|
<table>
|
|
165
116
|
<tr>
|
|
166
|
-
<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="
|
|
167
|
-
<td align="center"><a href="https://github.com/
|
|
168
|
-
<td align="center"><a href="https://github.com/
|
|
169
|
-
<td align="center"><a href="https://github.com/
|
|
170
|
-
<td align="center"><a href="https://github.com/
|
|
171
|
-
<td align="center"><a href="https://github.com/
|
|
172
|
-
<td align="center"><a href="https://github.com/
|
|
173
|
-
<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>
|
|
174
124
|
</tr>
|
|
175
125
|
<tr>
|
|
176
|
-
<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="
|
|
177
|
-
<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="
|
|
178
|
-
<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="
|
|
179
|
-
<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="
|
|
180
|
-
<td align="center"><a href="https://github.com/
|
|
181
|
-
<td align="center"><a href="https://github.com/
|
|
182
|
-
<td align="center"><a href="https://github.com/
|
|
183
|
-
<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>
|
|
184
133
|
</tr>
|
|
185
134
|
<tr>
|
|
186
|
-
<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>
|
|
187
138
|
</tr>
|
|
188
139
|
</table>
|
|
189
140
|
|
|
@@ -217,10 +168,21 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
217
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>
|
|
218
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>
|
|
219
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>
|
|
220
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>
|
|
221
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>
|
|
222
177
|
</p>
|
|
223
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
|
+
|
|
224
186
|
## License
|
|
225
187
|
|
|
226
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,15 +1,15 @@
|
|
|
1
|
-
import { AnySchema } from '@orpc/
|
|
2
|
-
import { ConditionalSchemaConverter, SchemaConvertOptions, JSONSchema } from '@orpc/openapi';
|
|
1
|
+
import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
3
2
|
import { ConversionConfig } from '@valibot/to-json-schema';
|
|
4
3
|
|
|
5
|
-
interface
|
|
4
|
+
interface ValibotToJsonSchemaConverterOptions extends Omit<ConversionConfig, 'target' | 'typeMode' | 'overrideRef'> {
|
|
6
5
|
}
|
|
7
|
-
declare class
|
|
8
|
-
private readonly
|
|
9
|
-
constructor(options?:
|
|
10
|
-
condition(schema: AnySchema | undefined): boolean;
|
|
11
|
-
convert(schema: AnySchema | undefined,
|
|
6
|
+
declare class ValibotToJsonSchemaConverter implements JsonSchemaConverter {
|
|
7
|
+
private readonly options;
|
|
8
|
+
constructor(options?: ValibotToJsonSchemaConverterOptions);
|
|
9
|
+
condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
|
|
10
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
11
|
+
private convertValibot;
|
|
12
12
|
}
|
|
13
13
|
|
|
14
|
-
export {
|
|
15
|
-
export type {
|
|
14
|
+
export { ValibotToJsonSchemaConverter };
|
|
15
|
+
export type { ValibotToJsonSchemaConverterOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { AnySchema } from '@orpc/
|
|
2
|
-
import { ConditionalSchemaConverter, SchemaConvertOptions, JSONSchema } from '@orpc/openapi';
|
|
1
|
+
import { JsonSchemaConverter, AnySchema, JsonSchemaConverterDirection, JsonSchema } from '@orpc/json-schema';
|
|
3
2
|
import { ConversionConfig } from '@valibot/to-json-schema';
|
|
4
3
|
|
|
5
|
-
interface
|
|
4
|
+
interface ValibotToJsonSchemaConverterOptions extends Omit<ConversionConfig, 'target' | 'typeMode' | 'overrideRef'> {
|
|
6
5
|
}
|
|
7
|
-
declare class
|
|
8
|
-
private readonly
|
|
9
|
-
constructor(options?:
|
|
10
|
-
condition(schema: AnySchema | undefined): boolean;
|
|
11
|
-
convert(schema: AnySchema | undefined,
|
|
6
|
+
declare class ValibotToJsonSchemaConverter implements JsonSchemaConverter {
|
|
7
|
+
private readonly options;
|
|
8
|
+
constructor(options?: ValibotToJsonSchemaConverterOptions);
|
|
9
|
+
condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
|
|
10
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
11
|
+
private convertValibot;
|
|
12
12
|
}
|
|
13
13
|
|
|
14
|
-
export {
|
|
15
|
-
export type {
|
|
14
|
+
export { ValibotToJsonSchemaConverter };
|
|
15
|
+
export type { ValibotToJsonSchemaConverterOptions };
|
package/dist/index.mjs
CHANGED
|
@@ -1,23 +1,69 @@
|
|
|
1
|
+
import { JsonSchemaXNativeType, JsonSchemaFormat } from '@orpc/json-schema';
|
|
1
2
|
import { toJsonSchema } from '@valibot/to-json-schema';
|
|
2
3
|
|
|
3
|
-
class
|
|
4
|
-
conversionConfig;
|
|
4
|
+
class ValibotToJsonSchemaConverter {
|
|
5
5
|
constructor(options = {}) {
|
|
6
|
-
this.
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
6
|
+
this.options = options;
|
|
7
|
+
}
|
|
8
|
+
condition(schema, _direction) {
|
|
9
|
+
return schema?.["~standard"].vendor === "valibot";
|
|
10
10
|
}
|
|
11
|
-
|
|
12
|
-
|
|
11
|
+
convert(schema, direction) {
|
|
12
|
+
const valibotSchema = schema;
|
|
13
|
+
const jsonSchema = this.convertValibot(valibotSchema, direction);
|
|
14
|
+
let optional = false;
|
|
15
|
+
try {
|
|
16
|
+
const result = valibotSchema["~standard"].validate(void 0);
|
|
17
|
+
if (!(result instanceof Promise) && !result.issues) {
|
|
18
|
+
optional = direction === "input" ? true : result.value === void 0;
|
|
19
|
+
}
|
|
20
|
+
} catch {
|
|
21
|
+
}
|
|
22
|
+
return [jsonSchema, optional];
|
|
13
23
|
}
|
|
14
|
-
|
|
24
|
+
convertValibot(schema, direction) {
|
|
15
25
|
const jsonSchema = toJsonSchema(schema, {
|
|
16
|
-
|
|
17
|
-
|
|
26
|
+
errorMode: "ignore",
|
|
27
|
+
...this.options,
|
|
28
|
+
target: "draft-2020-12",
|
|
29
|
+
typeMode: direction,
|
|
30
|
+
overrideSchema: (context) => {
|
|
31
|
+
if (context.valibotSchema.type === "bigint") {
|
|
32
|
+
context.jsonSchema.type = "string";
|
|
33
|
+
context.jsonSchema.pattern = "^-?[0-9]+$";
|
|
34
|
+
context.jsonSchema["x-native-type"] = JsonSchemaXNativeType.BigInt;
|
|
35
|
+
} else if (context.valibotSchema.type === "date") {
|
|
36
|
+
context.jsonSchema.type = "string";
|
|
37
|
+
context.jsonSchema.format = JsonSchemaFormat.DateTime;
|
|
38
|
+
context.jsonSchema["x-native-type"] = JsonSchemaXNativeType.Date;
|
|
39
|
+
} else if (context.valibotSchema.type === "set") {
|
|
40
|
+
const setSchema = context.valibotSchema;
|
|
41
|
+
context.jsonSchema.type = "array";
|
|
42
|
+
context.jsonSchema.uniqueItems = true;
|
|
43
|
+
context.jsonSchema.items = this.convertValibot(setSchema.value, direction);
|
|
44
|
+
context.jsonSchema["x-native-type"] = JsonSchemaXNativeType.Set;
|
|
45
|
+
} else if (context.valibotSchema.type === "map") {
|
|
46
|
+
const mapSchema = context.valibotSchema;
|
|
47
|
+
context.jsonSchema.type = "array";
|
|
48
|
+
context.jsonSchema.items = {
|
|
49
|
+
type: "array",
|
|
50
|
+
prefixItems: [
|
|
51
|
+
this.convertValibot(mapSchema.key, direction),
|
|
52
|
+
this.convertValibot(mapSchema.value, direction)
|
|
53
|
+
],
|
|
54
|
+
maxItems: 2,
|
|
55
|
+
minItems: 2
|
|
56
|
+
};
|
|
57
|
+
context.jsonSchema["x-native-type"] = JsonSchemaXNativeType.Map;
|
|
58
|
+
}
|
|
59
|
+
if (this.options.overrideSchema) {
|
|
60
|
+
return this.options.overrideSchema(context);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
18
63
|
});
|
|
19
|
-
|
|
64
|
+
const { $schema, ...rest } = jsonSchema;
|
|
65
|
+
return rest;
|
|
20
66
|
}
|
|
21
67
|
}
|
|
22
68
|
|
|
23
|
-
export {
|
|
69
|
+
export { ValibotToJsonSchemaConverter };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/valibot",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0-beta.1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
@@ -10,10 +10,12 @@
|
|
|
10
10
|
"directory": "packages/valibot"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"orpc"
|
|
13
|
+
"orpc",
|
|
14
|
+
"valibot"
|
|
14
15
|
],
|
|
15
16
|
"sideEffects": false,
|
|
16
17
|
"exports": {
|
|
18
|
+
"./package.json": "./package.json",
|
|
17
19
|
".": {
|
|
18
20
|
"types": "./dist/index.d.mts",
|
|
19
21
|
"import": "./dist/index.mjs",
|
|
@@ -24,21 +26,18 @@
|
|
|
24
26
|
"dist"
|
|
25
27
|
],
|
|
26
28
|
"peerDependencies": {
|
|
27
|
-
"valibot": ">=1.0.0"
|
|
28
|
-
"@orpc/contract": "1.14.5",
|
|
29
|
-
"@orpc/server": "1.14.5"
|
|
29
|
+
"valibot": ">=1.0.0"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@valibot/to-json-schema": "^1.5.0",
|
|
33
|
-
"@orpc/
|
|
33
|
+
"@orpc/json-schema": "2.0.0-beta.1"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"valibot": "^1.2.0",
|
|
37
|
-
"zod": "^4.3
|
|
37
|
+
"zod": "^4.4.3"
|
|
38
38
|
},
|
|
39
39
|
"scripts": {
|
|
40
40
|
"build": "unbuild",
|
|
41
|
-
"build:watch": "pnpm run build --watch",
|
|
42
41
|
"type:check": "tsc -b"
|
|
43
42
|
}
|
|
44
43
|
}
|