@orpc/json-schema 1.14.6 → 2.0.0-beta.10
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 +78 -87
- package/dist/index.d.mts +165 -17
- package/dist/index.d.ts +165 -17
- package/dist/index.mjs +735 -101
- package/package.json +8 -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,55 +18,48 @@
|
|
|
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 API contract as the single source of truth.
|
|
30
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
31
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
32
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to 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
|
+
**Built-in features**
|
|
49
41
|
|
|
50
|
-
|
|
42
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
43
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
44
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
45
|
+
|
|
46
|
+
**Framework & ecosystem integrations**
|
|
47
|
+
|
|
48
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
49
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
50
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
51
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
52
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
51
53
|
|
|
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/json-schema`
|
|
68
|
-
|
|
69
|
-
Json Schema related utilities for oRPC.
|
|
54
|
+
**Observability**
|
|
55
|
+
|
|
56
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
57
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
58
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
70
59
|
|
|
71
60
|
## Sponsors
|
|
72
61
|
|
|
73
|
-
|
|
62
|
+
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! 🚀
|
|
74
63
|
|
|
75
64
|
### 🏆 Platinum Sponsor
|
|
76
65
|
|
|
@@ -88,19 +77,11 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
88
77
|
</tr>
|
|
89
78
|
</table>
|
|
90
79
|
|
|
91
|
-
### 🥉 Bronze Sponsor
|
|
92
|
-
|
|
93
|
-
<table>
|
|
94
|
-
<tr>
|
|
95
|
-
<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>
|
|
96
|
-
</tr>
|
|
97
|
-
</table>
|
|
98
|
-
|
|
99
80
|
### Generous Sponsors
|
|
100
81
|
|
|
101
82
|
<table>
|
|
102
83
|
<tr>
|
|
103
|
-
<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="
|
|
84
|
+
<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>
|
|
104
85
|
</tr>
|
|
105
86
|
</table>
|
|
106
87
|
|
|
@@ -108,26 +89,26 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
108
89
|
|
|
109
90
|
<table>
|
|
110
91
|
<tr>
|
|
111
|
-
<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="
|
|
112
|
-
<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="
|
|
113
|
-
<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="
|
|
114
|
-
<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="
|
|
115
|
-
<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="
|
|
116
|
-
<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="
|
|
117
|
-
<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>
|
|
92
|
+
<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>
|
|
93
|
+
<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>
|
|
94
|
+
<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>
|
|
95
|
+
<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>
|
|
96
|
+
<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>
|
|
97
|
+
<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>
|
|
118
98
|
</tr>
|
|
119
99
|
<tr>
|
|
120
|
-
<td align="center"><a href="https://github.com/
|
|
121
|
-
<td align="center"><a href="https://github.com/
|
|
122
|
-
<td align="center"><a href="https://github.com/
|
|
123
|
-
<td align="center"><a href="https://github.com/
|
|
124
|
-
<td align="center"><a href="https://github.com/
|
|
125
|
-
<td align="center"><a href="https://github.com/
|
|
126
|
-
<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>
|
|
100
|
+
<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>
|
|
101
|
+
<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>
|
|
102
|
+
<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>
|
|
103
|
+
<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>
|
|
104
|
+
<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>
|
|
105
|
+
<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>
|
|
127
106
|
</tr>
|
|
128
107
|
<tr>
|
|
129
|
-
<td align="center"><a href="https://github.com/
|
|
130
|
-
<td align="center"><a href="https://github.com/
|
|
108
|
+
<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>
|
|
109
|
+
<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>
|
|
110
|
+
<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>
|
|
111
|
+
<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>
|
|
131
112
|
</tr>
|
|
132
113
|
</table>
|
|
133
114
|
|
|
@@ -135,28 +116,27 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
135
116
|
|
|
136
117
|
<table>
|
|
137
118
|
<tr>
|
|
138
|
-
<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="
|
|
139
|
-
<td align="center"><a href="https://github.com/
|
|
140
|
-
<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="
|
|
141
|
-
<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="
|
|
142
|
-
<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="
|
|
143
|
-
<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="
|
|
144
|
-
<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="
|
|
145
|
-
<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>
|
|
119
|
+
<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>
|
|
120
|
+
<td align="center"><a href="https://github.com/Nic13Gamer?ref=orpc" target="_blank" rel="noopener" title="Nicholas"><img src="https://avatars.githubusercontent.com/u/54724556?u=56a7ab430ce7a80d648ab6eba051d454a818ed0b&v=4" width="119" alt="Nicholas"/><br />Nicholas</a></td>
|
|
121
|
+
<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>
|
|
122
|
+
<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>
|
|
123
|
+
<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>
|
|
124
|
+
<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>
|
|
125
|
+
<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>
|
|
146
126
|
</tr>
|
|
147
127
|
<tr>
|
|
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/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&v=4" width="
|
|
154
|
-
<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="
|
|
155
|
-
<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="104" alt="Alex"/><br />Alex</a></td>
|
|
128
|
+
<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>
|
|
129
|
+
<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>
|
|
130
|
+
<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>
|
|
131
|
+
<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>
|
|
132
|
+
<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>
|
|
133
|
+
<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>
|
|
134
|
+
<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>
|
|
156
135
|
</tr>
|
|
157
136
|
<tr>
|
|
158
|
-
<td align="center"><a href="https://github.com/
|
|
159
|
-
<td align="center"><a href="https://github.com/
|
|
137
|
+
<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>
|
|
138
|
+
<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>
|
|
139
|
+
<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>
|
|
160
140
|
</tr>
|
|
161
141
|
</table>
|
|
162
142
|
|
|
@@ -172,7 +152,7 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
172
152
|
<a href="https://github.com/theoludwig?ref=orpc" target="_blank" rel="noopener" title="Théo LUDWIG"><img src="https://avatars.githubusercontent.com/u/25207499?u=a6a9653725a2f574c07893748806668e0598cdbe&v=4" width="32" height="32" alt="Théo LUDWIG" /></a>
|
|
173
153
|
<a href="https://github.com/abhay-ramesh?ref=orpc" target="_blank" rel="noopener" title="Abhay Ramesh"><img src="https://avatars.githubusercontent.com/u/66196314?u=c5c2b0327b26606c2efcfaf17046ab18c3d25c57&v=4" width="32" height="32" alt="Abhay Ramesh" /></a>
|
|
174
154
|
<a href="https://github.com/shr-ink?ref=orpc" target="_blank" rel="noopener" title="shr.ink oü"><img src="https://avatars.githubusercontent.com/u/139700438?v=4" width="32" height="32" alt="shr.ink oü" /></a>
|
|
175
|
-
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=
|
|
155
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=505e54608466ab53754f702973687b04c6424c1f&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
176
156
|
<a href="https://github.com/yzuyr?ref=orpc" target="_blank" rel="noopener" title="Ryuz"><img src="https://avatars.githubusercontent.com/u/196539378?u=d38374588d219b6748b16406982f6559411466d4&v=4" width="32" height="32" alt="Ryuz" /></a>
|
|
177
157
|
<a href="https://github.com/happyboy2022?ref=orpc" target="_blank" rel="noopener" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&v=4" width="32" height="32" alt="happyboy" /></a>
|
|
178
158
|
<a href="https://github.com/YiCChi?ref=orpc" target="_blank" rel="noopener" title="yicchi"><img src="https://avatars.githubusercontent.com/u/86967274?u=6c2756f09fe15dd94d572f560e979cd157982852&v=4" width="32" height="32" alt="yicchi" /></a>
|
|
@@ -192,9 +172,20 @@ If you find oRPC valuable and would like to support its development, you can do
|
|
|
192
172
|
<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>
|
|
193
173
|
<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>
|
|
194
174
|
<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>
|
|
175
|
+
<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>
|
|
195
176
|
<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>
|
|
177
|
+
<a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="Natt"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&v=4" width="32" height="32" alt="Natt" /></a>
|
|
178
|
+
<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>
|
|
179
|
+
<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>
|
|
196
180
|
</p>
|
|
197
181
|
|
|
182
|
+
## References
|
|
183
|
+
|
|
184
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
185
|
+
|
|
186
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
187
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
188
|
+
|
|
198
189
|
## License
|
|
199
190
|
|
|
200
191
|
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,11 +1,16 @@
|
|
|
1
|
-
import * as Draft07 from 'json-schema-typed/draft-07';
|
|
2
|
-
import * as Draft2019 from 'json-schema-typed/draft-2019-09';
|
|
3
1
|
import * as Draft2020 from 'json-schema-typed/draft-2020-12';
|
|
4
|
-
|
|
2
|
+
export { Format as JsonSchemaFormat, TypeName as JsonSchemaType } from 'json-schema-typed/draft-2020-12';
|
|
3
|
+
import { AnySchema, RouterContract } from '@orpc/contract';
|
|
4
|
+
export { AnySchema, Schema } from '@orpc/contract';
|
|
5
|
+
import { Promisable } from '@orpc/shared';
|
|
5
6
|
import { Context } from '@orpc/server';
|
|
6
7
|
import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
8
|
+
import { ClientContext } from '@orpc/client';
|
|
9
|
+
import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
|
|
10
|
+
import { StandardJSONSchemaV1 } from '@standard-schema/spec';
|
|
7
11
|
|
|
8
|
-
type JsonSchema = Draft2020.JSONSchema
|
|
12
|
+
type JsonSchema = Draft2020.JSONSchema;
|
|
13
|
+
type JsonSchemaKeywords = typeof Draft2020.keywords[number];
|
|
9
14
|
declare enum JsonSchemaXNativeType {
|
|
10
15
|
BigInt = "bigint",
|
|
11
16
|
RegExp = "regexp",
|
|
@@ -15,25 +20,168 @@ declare enum JsonSchemaXNativeType {
|
|
|
15
20
|
Map = "map"
|
|
16
21
|
}
|
|
17
22
|
|
|
18
|
-
interface JsonSchemaCoerceOptions {
|
|
19
|
-
components?: Record<string, JsonSchema>;
|
|
20
|
-
}
|
|
21
23
|
declare class JsonSchemaCoercer {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
+
coerce([schema, optional]: [schema: JsonSchema, optional: boolean], value: unknown): unknown;
|
|
25
|
+
private coerceInternal;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* These utilities assume the schema has only one root-level `$defs` object
|
|
30
|
+
* and exclusively use absolute JSON pointers for `$ref` values.
|
|
31
|
+
*/
|
|
32
|
+
|
|
33
|
+
declare function isJsonPrimitiveSchema(schema: JsonSchema): schema is JsonSchema & object;
|
|
34
|
+
type JsonFileSchema = JsonSchema & object & {
|
|
35
|
+
type: 'string';
|
|
36
|
+
contentMediaType?: string;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Returns true when the schema is a file-like string schema.
|
|
40
|
+
*/
|
|
41
|
+
declare function isJsonFileSchema(schema: JsonSchema): schema is JsonFileSchema;
|
|
42
|
+
type JsonObjectSchema = JsonSchema & object & {
|
|
43
|
+
type: 'object';
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Returns true when the schema is an object schema.
|
|
47
|
+
*/
|
|
48
|
+
declare function isJsonObjectSchema(schema: JsonSchema): schema is JsonObjectSchema;
|
|
49
|
+
type JsonArraySchema = JsonSchema & object & {
|
|
50
|
+
type: 'array';
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Returns true when the schema is an array schema.
|
|
54
|
+
*/
|
|
55
|
+
declare function isJsonArraySchema(schema: JsonSchema): schema is JsonArraySchema;
|
|
56
|
+
/**
|
|
57
|
+
* Returns true when the schema does not apply any recognized constraints.
|
|
58
|
+
*/
|
|
59
|
+
declare function isUnconstrainedSchema(schema: JsonSchema): boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Ensures a JSON Schema is represented as an object schema document.
|
|
62
|
+
*/
|
|
63
|
+
declare function ensureJsonSchemaObject(schema: JsonSchema): Exclude<JsonSchema, boolean>;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* These utilities assume the schema has only one root-level `$defs` object
|
|
67
|
+
* and exclusively use absolute JSON pointers for `$ref` values.
|
|
68
|
+
*/
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Combines multiple schemas under the requested composition keyword, promoting branch `$defs` to the root.
|
|
72
|
+
*/
|
|
73
|
+
declare function combineJsonSchemasWithComposition(keyword: 'allOf' | 'anyOf' | 'oneOf', schemas: JsonSchema[]): JsonSchema;
|
|
74
|
+
type JsonObjectSchemaEntry = [name: string, schema: JsonSchema, optional: boolean];
|
|
75
|
+
/**
|
|
76
|
+
* Combines object property entries back into a single object schema.
|
|
77
|
+
*/
|
|
78
|
+
declare function combineJsonObjectSchemaEntries(entries: JsonObjectSchemaEntry[]): JsonObjectSchema;
|
|
79
|
+
/**
|
|
80
|
+
* Parses an object schema, or a composition of object schemas, into property entries.
|
|
81
|
+
*/
|
|
82
|
+
declare function extractJsonObjectSchemaEntries(schema: JsonSchema): JsonObjectSchemaEntry[] | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* Flattens `anyOf` and `oneOf` unions when they are the only active constraints.
|
|
85
|
+
*/
|
|
86
|
+
declare function flattenJsonUnionSchema(schema: JsonSchema): JsonSchema[];
|
|
87
|
+
/**
|
|
88
|
+
* Matches a union made of a single item schema and its array form.
|
|
89
|
+
*/
|
|
90
|
+
declare function matchArrayableJsonSchema(schema: JsonSchema): undefined | [itemSchema: JsonSchema, arraySchema: JsonArraySchema];
|
|
91
|
+
declare function deduplicateJsonSchemas(schemas: JsonSchema[]): JsonSchema[];
|
|
92
|
+
|
|
93
|
+
type JsonSchemaConverterDirection = 'input' | 'output';
|
|
94
|
+
interface JsonSchemaConverter {
|
|
95
|
+
/**
|
|
96
|
+
* Determines whether this converter can handle the given schema.
|
|
97
|
+
*/
|
|
98
|
+
condition(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): Promisable<boolean>;
|
|
99
|
+
/**
|
|
100
|
+
* Converts an ORPC schema to a JSON Schema representation.
|
|
101
|
+
*/
|
|
102
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): Promisable<[jsonSchema: JsonSchema, optional: boolean]>;
|
|
103
|
+
}
|
|
104
|
+
declare class DelegatingJsonSchemaConverter implements Pick<JsonSchemaConverter, 'convert'> {
|
|
105
|
+
private readonly converters;
|
|
106
|
+
constructor(converters?: JsonSchemaConverter[]);
|
|
107
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): Promise<[jsonSchema: JsonSchema, optional: boolean]>;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* These utilities assume the schema has only one root-level `$defs` object
|
|
112
|
+
* and exclusively use absolute JSON pointers for `$ref` values.
|
|
113
|
+
*/
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Encodes a JSON Pointer segment according to RFC 6901.
|
|
117
|
+
*
|
|
118
|
+
* https://datatracker.ietf.org/doc/html/rfc6901
|
|
119
|
+
*/
|
|
120
|
+
declare function encodeJsonPointerSegment(segment: string): string;
|
|
121
|
+
/**
|
|
122
|
+
* Decodes a JSON Pointer segment according to RFC 6901.
|
|
123
|
+
*
|
|
124
|
+
* https://datatracker.ietf.org/doc/html/rfc6901
|
|
125
|
+
*/
|
|
126
|
+
declare function decodeJsonPointerSegment(segment: string): string;
|
|
127
|
+
declare function mapJsonSchemaRefs(value: JsonSchema, map: (ref: string, path: Array<string | number>) => string, schemaLevel?: boolean, path?: Array<string | number>): JsonSchema;
|
|
128
|
+
/**
|
|
129
|
+
* Rewrites recursive root `#` refs by moving the schema body into `$defs`.
|
|
130
|
+
*/
|
|
131
|
+
declare function hoistRecursiveRefToDef(schema: JsonSchema): JsonSchema;
|
|
132
|
+
/**
|
|
133
|
+
* Resolves a local `$ref` at the **root level** of the given schema, if present.
|
|
134
|
+
*
|
|
135
|
+
* Only handles refs of the form `#/$defs/<name>` pointing into the provided
|
|
136
|
+
* (or schema-embedded) `$defs` map. Nested `$ref`s inside sub-schemas are
|
|
137
|
+
* intentionally left untouched.
|
|
138
|
+
*
|
|
139
|
+
* If the ref cannot be resolved (missing `$defs`, unknown key, etc.) the
|
|
140
|
+
* schema is returned as-is.
|
|
141
|
+
*
|
|
142
|
+
* @param schema - The schema whose root-level `$ref` should be resolved.
|
|
143
|
+
* @param $defs - Definition map to resolve against. If omitted, falls back to
|
|
144
|
+
* `schema.$defs`. When provided, takes precedence over any `$defs` embedded
|
|
145
|
+
* in the schema.
|
|
146
|
+
*/
|
|
147
|
+
declare function resolveJsonSchemaRootLocalRef(schema: JsonSchema, $defs?: Exclude<JsonSchema, boolean>['$defs']): JsonSchema;
|
|
148
|
+
|
|
149
|
+
interface SmartCoercionHandlerPluginOptions {
|
|
150
|
+
converters?: undefined | JsonSchemaConverter[];
|
|
151
|
+
}
|
|
152
|
+
declare class SmartCoercionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
153
|
+
name: string;
|
|
154
|
+
private readonly converter;
|
|
155
|
+
private readonly coercer;
|
|
156
|
+
private readonly cache;
|
|
157
|
+
constructor(options?: SmartCoercionHandlerPluginOptions);
|
|
158
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
159
|
+
private coerceValue;
|
|
24
160
|
}
|
|
25
161
|
|
|
26
|
-
interface
|
|
27
|
-
|
|
162
|
+
interface SmartCoercionLinkPluginOptions {
|
|
163
|
+
converters?: undefined | JsonSchemaConverter[];
|
|
28
164
|
}
|
|
29
|
-
declare class
|
|
30
|
-
|
|
165
|
+
declare class SmartCoercionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
166
|
+
private readonly contract;
|
|
167
|
+
name: string;
|
|
168
|
+
/**
|
|
169
|
+
* Output and error values should be coerced before validation.
|
|
170
|
+
*/
|
|
171
|
+
after: string[];
|
|
31
172
|
private readonly converter;
|
|
32
173
|
private readonly coercer;
|
|
33
174
|
private readonly cache;
|
|
34
|
-
constructor(options?:
|
|
35
|
-
init(options:
|
|
175
|
+
constructor(contract: RouterContract, options?: SmartCoercionLinkPluginOptions);
|
|
176
|
+
init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
|
|
177
|
+
private coerceValue;
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
declare class StandardJsonSchemaConverter implements JsonSchemaConverter {
|
|
181
|
+
condition(schema: AnySchema | undefined, _direction: JsonSchemaConverterDirection): boolean;
|
|
182
|
+
convert(schema: AnySchema | undefined, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
183
|
+
convertInternal(schema: StandardJSONSchemaV1 & AnySchema, direction: JsonSchemaConverterDirection): [jsonSchema: JsonSchema, optional: boolean];
|
|
36
184
|
}
|
|
37
185
|
|
|
38
|
-
export { JsonSchemaCoercer, JsonSchemaXNativeType,
|
|
39
|
-
export type { JsonSchema,
|
|
186
|
+
export { DelegatingJsonSchemaConverter, JsonSchemaCoercer, JsonSchemaXNativeType, SmartCoercionHandlerPlugin, SmartCoercionLinkPlugin, StandardJsonSchemaConverter, combineJsonObjectSchemaEntries, combineJsonSchemasWithComposition, decodeJsonPointerSegment, deduplicateJsonSchemas, encodeJsonPointerSegment, ensureJsonSchemaObject, extractJsonObjectSchemaEntries, flattenJsonUnionSchema, hoistRecursiveRefToDef, isJsonArraySchema, isJsonFileSchema, isJsonObjectSchema, isJsonPrimitiveSchema, isUnconstrainedSchema, mapJsonSchemaRefs, matchArrayableJsonSchema, resolveJsonSchemaRootLocalRef };
|
|
187
|
+
export type { JsonArraySchema, JsonFileSchema, JsonObjectSchema, JsonObjectSchemaEntry, JsonSchema, JsonSchemaConverter, JsonSchemaConverterDirection, JsonSchemaKeywords, SmartCoercionHandlerPluginOptions, SmartCoercionLinkPluginOptions };
|