@orpc/standard-server 0.0.0-next.6b06c96 → 0.0.0-next.6bc474e
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 +143 -33
- package/dist/batch/index.d.mts +30 -0
- package/dist/batch/index.d.ts +30 -0
- package/dist/batch/index.mjs +150 -0
- package/dist/index.d.mts +15 -33
- package/dist/index.d.ts +15 -33
- package/dist/index.mjs +54 -4
- package/dist/shared/standard-server.BD8Sg1A5.d.mts +38 -0
- package/dist/shared/standard-server.BD8Sg1A5.d.ts +38 -0
- package/package.json +9 -4
package/README.md
CHANGED
|
@@ -1,65 +1,65 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
<image align="center" src="https://orpc.
|
|
2
|
+
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
3
|
</div>
|
|
4
4
|
|
|
5
5
|
<h1></h1>
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
|
-
<a href="https://codecov.io/gh/
|
|
9
|
-
<img alt="codecov" src="https://codecov.io/gh/
|
|
8
|
+
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
10
10
|
</a>
|
|
11
11
|
<a href="https://www.npmjs.com/package/@orpc/standard-server">
|
|
12
12
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fstandard-server?logo=npm" />
|
|
13
13
|
</a>
|
|
14
|
-
<a href="https://github.com/
|
|
15
|
-
<img alt="MIT License" src="https://img.shields.io/github/license/
|
|
14
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
16
16
|
</a>
|
|
17
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/middleapi/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
20
23
|
</div>
|
|
21
24
|
|
|
22
25
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
23
26
|
|
|
24
|
-
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
27
|
+
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
25
28
|
|
|
26
29
|
---
|
|
27
30
|
|
|
28
31
|
## Highlights
|
|
29
32
|
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
|
43
|
-
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
|
44
|
-
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
|
45
|
-
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
|
33
|
+
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
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.
|
|
46
45
|
|
|
47
46
|
## Documentation
|
|
48
47
|
|
|
49
|
-
You can find the full documentation [here](https://orpc.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
50
49
|
|
|
51
50
|
## Packages
|
|
52
51
|
|
|
53
52
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
54
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
55
54
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
55
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
56
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
56
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
57
|
-
- [@orpc/
|
|
58
|
-
- [@orpc/
|
|
59
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
60
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
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
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
-
- [@orpc/
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
64
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
65
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
@@ -70,12 +70,122 @@ This package is designed to be used as a base for other server implementations.
|
|
|
70
70
|
|
|
71
71
|
## Sponsors
|
|
72
72
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
73
|
+
If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
|
|
74
|
+
|
|
75
|
+
### 🏆 Platinum Sponsor
|
|
76
|
+
|
|
77
|
+
<table>
|
|
78
|
+
<tr>
|
|
79
|
+
<td align="center"><a href="https://screenshotone.com/?ref=orpc" target="_blank" rel="noopener" title="ScreenshotOne.com"><img src="https://avatars.githubusercontent.com/u/97035603?v=4" width="279" alt="ScreenshotOne.com"/><br />ScreenshotOne.com</a></td>
|
|
80
|
+
</tr>
|
|
81
|
+
</table>
|
|
82
|
+
|
|
83
|
+
### 🥇 Gold Sponsor
|
|
84
|
+
|
|
85
|
+
<table>
|
|
86
|
+
<tr>
|
|
87
|
+
<td align="center"><a href="https://zuplo.link/orpc?ref=orpc" target="_blank" rel="noopener" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="209" alt="Zuplo"/><br />Zuplo</a></td>
|
|
88
|
+
</tr>
|
|
89
|
+
</table>
|
|
90
|
+
|
|
91
|
+
### 🥈 Silver Sponsor
|
|
92
|
+
|
|
93
|
+
<table>
|
|
94
|
+
<tr>
|
|
95
|
+
<td align="center"><a href="https://misskey.io/?ref=orpc" target="_blank" rel="noopener" title="村上さん"><img src="https://avatars.githubusercontent.com/u/37681609?u=0dd4c7e4ba937cbb52b068c55914b1d8164dc0c7&v=4" width="167" alt="村上さん"/><br />村上さん</a></td>
|
|
96
|
+
<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="167" alt="christ12938"/><br />christ12938</a></td>
|
|
97
|
+
</tr>
|
|
98
|
+
</table>
|
|
99
|
+
|
|
100
|
+
### Generous Sponsors
|
|
101
|
+
|
|
102
|
+
<table>
|
|
103
|
+
<tr>
|
|
104
|
+
<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="139" alt="LN Markets"/><br />LN Markets</a></td>
|
|
105
|
+
</tr>
|
|
106
|
+
</table>
|
|
107
|
+
|
|
108
|
+
### Sponsors
|
|
109
|
+
|
|
110
|
+
<table>
|
|
111
|
+
<tr>
|
|
112
|
+
<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="119" alt="Reece McDonald"/><br />Reece McDonald</a></td>
|
|
113
|
+
<td align="center"><a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="noopener" title="あわわわとーにゅ"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&v=4" width="119" alt="あわわわとーにゅ"/><br />あわわわとーにゅ</a></td>
|
|
114
|
+
<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="119" alt="nk"/><br />nk</a></td>
|
|
115
|
+
<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="119" alt="supastarter"/><br />supastarter</a></td>
|
|
116
|
+
<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="119" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
|
|
117
|
+
<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="119" alt="herrfugbaum"/><br />herrfugbaum</a></td>
|
|
118
|
+
<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="119" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
|
|
119
|
+
</tr>
|
|
120
|
+
<tr>
|
|
121
|
+
<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>
|
|
122
|
+
<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="119" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
123
|
+
<td align="center"><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="119" alt="happyboy"/><br />happyboy</a></td>
|
|
124
|
+
<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="119" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
125
|
+
<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="119" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
126
|
+
<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="119" alt="Andrew Peters"/><br />Andrew Peters</a></td>
|
|
127
|
+
<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="119" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr>
|
|
130
|
+
<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>
|
|
131
|
+
<td align="center"><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="119" alt="Chen, Zhi-Yuan"/><br />Chen, Zhi-Yuan</a></td>
|
|
132
|
+
<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="119" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
133
|
+
</tr>
|
|
134
|
+
</table>
|
|
135
|
+
|
|
136
|
+
### Backers
|
|
137
|
+
|
|
138
|
+
<table>
|
|
139
|
+
<tr>
|
|
140
|
+
<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="104" alt="David Walsh"/><br />David Walsh</a></td>
|
|
141
|
+
<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="104" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
|
|
142
|
+
<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="104" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
|
|
143
|
+
<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="104" alt="soonoo"/><br />soonoo</a></td>
|
|
144
|
+
<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="104" alt="Kevin Porten"/><br />Kevin Porten</a></td>
|
|
145
|
+
<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="104" alt="Denis"/><br />Denis</a></td>
|
|
146
|
+
<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?v=4" width="104" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
|
|
147
|
+
<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="104" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
|
|
148
|
+
</tr>
|
|
149
|
+
<tr>
|
|
150
|
+
<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="104" alt="Sam"/><br />Sam</a></td>
|
|
151
|
+
<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="104" alt="Titoine"/><br />Titoine</a></td>
|
|
152
|
+
<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="104" alt="Igor Makowski"/><br />Igor Makowski</a></td>
|
|
153
|
+
<td align="center"><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="104" alt="Anees Iqbal"/><br />Anees Iqbal</a></td>
|
|
154
|
+
<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>
|
|
155
|
+
</tr>
|
|
156
|
+
</table>
|
|
157
|
+
|
|
158
|
+
### Past Sponsors
|
|
159
|
+
|
|
160
|
+
<p>
|
|
161
|
+
<a href="https://github.com/MrMaxie?ref=orpc" target="_blank" rel="noopener" title="Maxie"><img src="https://avatars.githubusercontent.com/u/3857836?u=5e6b57973d4385d655663ffdd836e487856f2984&v=4" width="32" height="32" alt="Maxie" /></a>
|
|
162
|
+
<a href="https://github.com/Stijn-Timmer?ref=orpc" target="_blank" rel="noopener" title="Stijn Timmer"><img src="https://avatars.githubusercontent.com/u/100147665?u=106b2c18e9c98a61861b4ee7fc100f5b9906a6c9&v=4" width="32" height="32" alt="Stijn Timmer" /></a>
|
|
163
|
+
<a href="https://github.com/motopods?ref=orpc" target="_blank" rel="noopener" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?u=18833983d65b481ae90a4adec2373064ec58bcf3&v=4" width="32" height="32" alt="motopods" /></a>
|
|
164
|
+
<a href="https://github.com/franciscohermida?ref=orpc" target="_blank" rel="noopener" title="Francisco Hermida"><img src="https://avatars.githubusercontent.com/u/483242?u=bbcbc80eb9d8781ff401f7dafc3b59cd7bea0561&v=4" width="32" height="32" alt="Francisco Hermida" /></a>
|
|
165
|
+
<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>
|
|
166
|
+
<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>
|
|
167
|
+
<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>
|
|
168
|
+
<a href="https://github.com/johngerome?ref=orpc" target="_blank" rel="noopener" title="0x4e32"><img src="https://avatars.githubusercontent.com/u/2002000?u=24e8dd943cfc862aa284d858a023532c75071ade&v=4" width="32" height="32" alt="0x4e32" /></a>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<a href="https://github.com/cloudycotton?ref=orpc" target="_blank" rel="noopener" title="Saksham"><img src="https://avatars.githubusercontent.com/u/168998965?u=9b9634a5aed66a51c1b880663272725b00b92b14&v=4" width="32" height="32" alt="Saksham" /></a>
|
|
172
|
+
<a href="https://github.com/hrynevychroman?ref=orpc" target="_blank" rel="noopener" title="Roman Hrynevych"><img src="https://avatars.githubusercontent.com/u/82209198?u=1a1d111ab3d589855b9cc8a7fefb1b5c6a4fbbaf&v=4" width="32" height="32" alt="Roman Hrynevych" /></a>
|
|
173
|
+
<a href="https://github.com/rokitgg?ref=orpc" target="_blank" rel="noopener" title="rokitg"><img src="https://avatars.githubusercontent.com/u/125133357?u=06c74aefaa2236b06a2e5fba5a5c612339f45912&v=4" width="32" height="32" alt="rokitg" /></a>
|
|
174
|
+
<a href="https://github.com/omarkhatibgg?ref=orpc" target="_blank" rel="noopener" title="Omar Khatib"><img src="https://avatars.githubusercontent.com/u/9054278?u=afbba7331b85c51b8eee4130f5fd31b1017dc919&v=4" width="32" height="32" alt="Omar Khatib" /></a>
|
|
175
|
+
<a href="https://github.com/YuSabo90002?ref=orpc" target="_blank" rel="noopener" title="Yu-Sabo"><img src="https://avatars.githubusercontent.com/u/13120582?v=4" width="32" height="32" alt="Yu-Sabo" /></a>
|
|
176
|
+
<a href="https://github.com/bapspatil?ref=orpc" target="_blank" rel="noopener" title="Bapusaheb Patil"><img src="https://avatars.githubusercontent.com/u/16699418?v=4" width="32" height="32" alt="Bapusaheb Patil" /></a>
|
|
177
|
+
<a href="https://github.com/ripgrim?ref=orpc" target="_blank" rel="noopener" title="grim"><img src="https://avatars.githubusercontent.com/u/75869731?u=b17c42ec2309552fdb822a86b25a2f99146a4d72&v=4" width="32" height="32" alt="grim" /></a>
|
|
178
|
+
<a href="https://github.com/nelsonlaidev?ref=orpc" target="_blank" rel="noopener" title="Nelson Lai"><img src="https://avatars.githubusercontent.com/u/75498339?u=2fc0e0b95dd184c5ffb744df977cb15a18b60672&v=4" width="32" height="32" alt="Nelson Lai" /></a>
|
|
179
|
+
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
|
|
180
|
+
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
181
|
+
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
182
|
+
<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>
|
|
183
|
+
<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>
|
|
184
|
+
<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>
|
|
185
|
+
<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>
|
|
186
|
+
<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>
|
|
77
187
|
</p>
|
|
78
188
|
|
|
79
189
|
## License
|
|
80
190
|
|
|
81
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/
|
|
191
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.mjs';
|
|
2
|
+
import { Promisable } from '@orpc/shared';
|
|
3
|
+
|
|
4
|
+
interface ToBatchRequestOptions {
|
|
5
|
+
url: URL;
|
|
6
|
+
method: 'GET' | 'POST';
|
|
7
|
+
headers: StandardHeaders;
|
|
8
|
+
requests: readonly StandardRequest[];
|
|
9
|
+
}
|
|
10
|
+
declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
|
|
11
|
+
declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
|
|
12
|
+
|
|
13
|
+
type BatchResponseMode = 'streaming' | 'buffered';
|
|
14
|
+
interface BatchResponseBodyItem extends StandardResponse {
|
|
15
|
+
index: number;
|
|
16
|
+
}
|
|
17
|
+
interface ToBatchResponseOptions extends StandardResponse {
|
|
18
|
+
body: AsyncIteratorObject<BatchResponseBodyItem>;
|
|
19
|
+
/**
|
|
20
|
+
* @default 'streaming'
|
|
21
|
+
*/
|
|
22
|
+
mode?: BatchResponseMode;
|
|
23
|
+
}
|
|
24
|
+
declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
|
|
25
|
+
declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
|
|
26
|
+
|
|
27
|
+
declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
|
|
28
|
+
|
|
29
|
+
export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
|
|
30
|
+
export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { S as StandardHeaders, c as StandardRequest, e as StandardResponse } from '../shared/standard-server.BD8Sg1A5.js';
|
|
2
|
+
import { Promisable } from '@orpc/shared';
|
|
3
|
+
|
|
4
|
+
interface ToBatchRequestOptions {
|
|
5
|
+
url: URL;
|
|
6
|
+
method: 'GET' | 'POST';
|
|
7
|
+
headers: StandardHeaders;
|
|
8
|
+
requests: readonly StandardRequest[];
|
|
9
|
+
}
|
|
10
|
+
declare function toBatchRequest(options: ToBatchRequestOptions): StandardRequest;
|
|
11
|
+
declare function parseBatchRequest(request: StandardRequest): StandardRequest[];
|
|
12
|
+
|
|
13
|
+
type BatchResponseMode = 'streaming' | 'buffered';
|
|
14
|
+
interface BatchResponseBodyItem extends StandardResponse {
|
|
15
|
+
index: number;
|
|
16
|
+
}
|
|
17
|
+
interface ToBatchResponseOptions extends StandardResponse {
|
|
18
|
+
body: AsyncIteratorObject<BatchResponseBodyItem>;
|
|
19
|
+
/**
|
|
20
|
+
* @default 'streaming'
|
|
21
|
+
*/
|
|
22
|
+
mode?: BatchResponseMode;
|
|
23
|
+
}
|
|
24
|
+
declare function toBatchResponse(options: ToBatchResponseOptions): Promisable<StandardResponse>;
|
|
25
|
+
declare function parseBatchResponse(response: StandardResponse): AsyncGenerator<BatchResponseBodyItem>;
|
|
26
|
+
|
|
27
|
+
declare function toBatchAbortSignal(signals: readonly (AbortSignal | undefined)[]): AbortSignal | undefined;
|
|
28
|
+
|
|
29
|
+
export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
|
|
30
|
+
export type { BatchResponseBodyItem, BatchResponseMode, ToBatchRequestOptions, ToBatchResponseOptions };
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
import { stringifyJSON, parseEmptyableJSON, AsyncIteratorClass, isAsyncIteratorObject, isObject } from '@orpc/shared';
|
|
2
|
+
|
|
3
|
+
function toBatchAbortSignal(signals) {
|
|
4
|
+
const realSignals = signals.filter((signal) => signal !== void 0);
|
|
5
|
+
if (realSignals.length === 0 || realSignals.length !== signals.length) {
|
|
6
|
+
return void 0;
|
|
7
|
+
}
|
|
8
|
+
const controller = new AbortController();
|
|
9
|
+
const abortIfAllInputsAborted = () => {
|
|
10
|
+
if (realSignals.every((signal) => signal.aborted)) {
|
|
11
|
+
controller.abort();
|
|
12
|
+
}
|
|
13
|
+
};
|
|
14
|
+
abortIfAllInputsAborted();
|
|
15
|
+
for (const signal of realSignals) {
|
|
16
|
+
signal.addEventListener("abort", () => {
|
|
17
|
+
abortIfAllInputsAborted();
|
|
18
|
+
}, {
|
|
19
|
+
once: true,
|
|
20
|
+
signal: controller.signal
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
return controller.signal;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
function toBatchRequest(options) {
|
|
27
|
+
const url = new URL(options.url);
|
|
28
|
+
let body;
|
|
29
|
+
const batchRequestItems = options.requests.map((request) => ({
|
|
30
|
+
body: request.body,
|
|
31
|
+
headers: Object.keys(request.headers).length ? request.headers : void 0,
|
|
32
|
+
method: request.method === options.method ? void 0 : request.method,
|
|
33
|
+
url: request.url
|
|
34
|
+
}));
|
|
35
|
+
if (options.method === "GET") {
|
|
36
|
+
url.searchParams.append("batch", stringifyJSON(batchRequestItems));
|
|
37
|
+
} else if (options.method === "POST") {
|
|
38
|
+
body = batchRequestItems;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
method: options.method,
|
|
42
|
+
url,
|
|
43
|
+
headers: options.headers,
|
|
44
|
+
body,
|
|
45
|
+
signal: toBatchAbortSignal(options.requests.map((request) => request.signal))
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
function parseBatchRequest(request) {
|
|
49
|
+
const items = request.method === "GET" ? parseEmptyableJSON(request.url.searchParams.getAll("batch").at(-1)) : request.body;
|
|
50
|
+
if (!Array.isArray(items)) {
|
|
51
|
+
throw new TypeError("Invalid batch request");
|
|
52
|
+
}
|
|
53
|
+
return items.map((item) => {
|
|
54
|
+
return {
|
|
55
|
+
method: item.method ?? request.method,
|
|
56
|
+
url: new URL(item.url),
|
|
57
|
+
headers: item.headers ?? {},
|
|
58
|
+
body: item.body,
|
|
59
|
+
signal: request.signal
|
|
60
|
+
};
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
function toBatchResponse(options) {
|
|
65
|
+
const mode = options.mode ?? "streaming";
|
|
66
|
+
const minifyResponseItem = (item) => {
|
|
67
|
+
return {
|
|
68
|
+
index: item.index,
|
|
69
|
+
status: item.status === options.status ? void 0 : item.status,
|
|
70
|
+
headers: Object.keys(item.headers).length ? item.headers : void 0,
|
|
71
|
+
body: item.body
|
|
72
|
+
};
|
|
73
|
+
};
|
|
74
|
+
if (mode === "buffered") {
|
|
75
|
+
return (async () => {
|
|
76
|
+
try {
|
|
77
|
+
const body = [];
|
|
78
|
+
for await (const item of options.body) {
|
|
79
|
+
body.push(minifyResponseItem(item));
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
headers: options.headers,
|
|
83
|
+
status: options.status,
|
|
84
|
+
body
|
|
85
|
+
};
|
|
86
|
+
} finally {
|
|
87
|
+
await options.body.return?.();
|
|
88
|
+
}
|
|
89
|
+
})();
|
|
90
|
+
}
|
|
91
|
+
return {
|
|
92
|
+
headers: options.headers,
|
|
93
|
+
status: options.status,
|
|
94
|
+
body: new AsyncIteratorClass(
|
|
95
|
+
async () => {
|
|
96
|
+
const { done, value } = await options.body.next();
|
|
97
|
+
if (done) {
|
|
98
|
+
return { done, value };
|
|
99
|
+
}
|
|
100
|
+
return {
|
|
101
|
+
done,
|
|
102
|
+
value: {
|
|
103
|
+
index: value.index,
|
|
104
|
+
status: value.status === options.status ? void 0 : value.status,
|
|
105
|
+
headers: Object.keys(value.headers).length ? value.headers : void 0,
|
|
106
|
+
body: value.body
|
|
107
|
+
}
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
async (reason) => {
|
|
111
|
+
if (reason !== "next") {
|
|
112
|
+
await options.body.return?.();
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
)
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
function parseBatchResponse(response) {
|
|
119
|
+
const body = response.body;
|
|
120
|
+
if (isAsyncIteratorObject(body) || Array.isArray(body)) {
|
|
121
|
+
const iterator = (async function* () {
|
|
122
|
+
for await (const item of body) {
|
|
123
|
+
if (!isObject(item) || !("index" in item) || typeof item.index !== "number") {
|
|
124
|
+
throw new TypeError("Invalid batch response", {
|
|
125
|
+
cause: item
|
|
126
|
+
});
|
|
127
|
+
}
|
|
128
|
+
yield {
|
|
129
|
+
index: item.index,
|
|
130
|
+
status: item.status ?? response.status,
|
|
131
|
+
headers: item.headers ?? {},
|
|
132
|
+
body: item.body
|
|
133
|
+
};
|
|
134
|
+
}
|
|
135
|
+
})();
|
|
136
|
+
return new AsyncIteratorClass(
|
|
137
|
+
() => iterator.next(),
|
|
138
|
+
async (reason) => {
|
|
139
|
+
if (reason !== "next" && isAsyncIteratorObject(body)) {
|
|
140
|
+
await body.return?.();
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
);
|
|
144
|
+
}
|
|
145
|
+
throw new TypeError("Invalid batch response", {
|
|
146
|
+
cause: response
|
|
147
|
+
});
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
export { parseBatchRequest, parseBatchResponse, toBatchAbortSignal, toBatchRequest, toBatchResponse };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
import { AsyncIteratorClass } from '@orpc/shared';
|
|
2
|
+
import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.mjs';
|
|
3
|
+
export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.mjs';
|
|
4
|
+
|
|
1
5
|
interface EventMessage {
|
|
2
6
|
event: string | undefined;
|
|
3
7
|
id: string | undefined;
|
|
@@ -49,45 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
|
|
|
49
53
|
declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
|
|
50
54
|
declare function getEventMeta(container: unknown): EventMeta | undefined;
|
|
51
55
|
|
|
52
|
-
interface
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
56
|
-
interface StandardRequest {
|
|
57
|
-
method: string;
|
|
58
|
-
url: URL;
|
|
59
|
-
headers: StandardHeaders;
|
|
60
|
-
/**
|
|
61
|
-
* The body has been parsed based on the content-type header.
|
|
62
|
-
*/
|
|
63
|
-
body: StandardBody;
|
|
64
|
-
signal: AbortSignal | undefined;
|
|
65
|
-
}
|
|
66
|
-
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
67
|
-
/**
|
|
68
|
-
* The body has been parsed based on the content-type header.
|
|
69
|
-
* This method can safely call multiple times (cached).
|
|
70
|
-
*/
|
|
71
|
-
body: () => Promise<StandardBody>;
|
|
72
|
-
}
|
|
73
|
-
interface StandardResponse {
|
|
74
|
-
status: number;
|
|
75
|
-
headers: StandardHeaders;
|
|
76
|
-
/**
|
|
77
|
-
* The body has been parsed based on the content-type header.
|
|
78
|
-
*/
|
|
79
|
-
body: StandardBody;
|
|
56
|
+
interface HibernationEventIteratorCallback {
|
|
57
|
+
(id: string): void;
|
|
80
58
|
}
|
|
81
|
-
|
|
59
|
+
declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
|
|
82
60
|
/**
|
|
83
|
-
*
|
|
84
|
-
* This method can safely call multiple times (cached).
|
|
61
|
+
* this property is not transferred to the client, so it should be optional for type safety
|
|
85
62
|
*/
|
|
86
|
-
|
|
63
|
+
readonly hibernationCallback?: HibernationEventIteratorCallback;
|
|
64
|
+
constructor(hibernationCallback: HibernationEventIteratorCallback);
|
|
87
65
|
}
|
|
88
66
|
|
|
89
67
|
declare function generateContentDisposition(filename: string): string;
|
|
90
68
|
declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
|
|
91
69
|
declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
|
|
70
|
+
declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
|
|
71
|
+
declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
|
|
72
|
+
declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
|
|
92
73
|
|
|
93
|
-
export { ErrorEvent,
|
|
74
|
+
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
|
|
75
|
+
export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
import { AsyncIteratorClass } from '@orpc/shared';
|
|
2
|
+
import { S as StandardHeaders, a as StandardLazyResponse } from './shared/standard-server.BD8Sg1A5.js';
|
|
3
|
+
export { b as StandardBody, d as StandardLazyRequest, c as StandardRequest, e as StandardResponse } from './shared/standard-server.BD8Sg1A5.js';
|
|
4
|
+
|
|
1
5
|
interface EventMessage {
|
|
2
6
|
event: string | undefined;
|
|
3
7
|
id: string | undefined;
|
|
@@ -49,45 +53,23 @@ type EventMeta = Partial<Pick<EventMessage, 'retry' | 'id' | 'comments'>>;
|
|
|
49
53
|
declare function withEventMeta<T extends object>(container: T, meta: EventMeta): T;
|
|
50
54
|
declare function getEventMeta(container: unknown): EventMeta | undefined;
|
|
51
55
|
|
|
52
|
-
interface
|
|
53
|
-
|
|
54
|
-
}
|
|
55
|
-
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
56
|
-
interface StandardRequest {
|
|
57
|
-
method: string;
|
|
58
|
-
url: URL;
|
|
59
|
-
headers: StandardHeaders;
|
|
60
|
-
/**
|
|
61
|
-
* The body has been parsed based on the content-type header.
|
|
62
|
-
*/
|
|
63
|
-
body: StandardBody;
|
|
64
|
-
signal: AbortSignal | undefined;
|
|
65
|
-
}
|
|
66
|
-
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
67
|
-
/**
|
|
68
|
-
* The body has been parsed based on the content-type header.
|
|
69
|
-
* This method can safely call multiple times (cached).
|
|
70
|
-
*/
|
|
71
|
-
body: () => Promise<StandardBody>;
|
|
72
|
-
}
|
|
73
|
-
interface StandardResponse {
|
|
74
|
-
status: number;
|
|
75
|
-
headers: StandardHeaders;
|
|
76
|
-
/**
|
|
77
|
-
* The body has been parsed based on the content-type header.
|
|
78
|
-
*/
|
|
79
|
-
body: StandardBody;
|
|
56
|
+
interface HibernationEventIteratorCallback {
|
|
57
|
+
(id: string): void;
|
|
80
58
|
}
|
|
81
|
-
|
|
59
|
+
declare class HibernationEventIterator<T, TReturn = unknown, TNext = unknown> extends AsyncIteratorClass<T, TReturn, TNext> {
|
|
82
60
|
/**
|
|
83
|
-
*
|
|
84
|
-
* This method can safely call multiple times (cached).
|
|
61
|
+
* this property is not transferred to the client, so it should be optional for type safety
|
|
85
62
|
*/
|
|
86
|
-
|
|
63
|
+
readonly hibernationCallback?: HibernationEventIteratorCallback;
|
|
64
|
+
constructor(hibernationCallback: HibernationEventIteratorCallback);
|
|
87
65
|
}
|
|
88
66
|
|
|
89
67
|
declare function generateContentDisposition(filename: string): string;
|
|
90
68
|
declare function getFilenameFromContentDisposition(contentDisposition: string): string | undefined;
|
|
91
69
|
declare function mergeStandardHeaders(a: StandardHeaders, b: StandardHeaders): StandardHeaders;
|
|
70
|
+
declare function flattenHeader(header: string | readonly string[] | undefined): string | undefined;
|
|
71
|
+
declare function replicateStandardLazyResponse(response: StandardLazyResponse, count: number): StandardLazyResponse[];
|
|
72
|
+
declare function isEventIteratorHeaders(headers: StandardHeaders): boolean;
|
|
92
73
|
|
|
93
|
-
export { ErrorEvent,
|
|
74
|
+
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, StandardHeaders, StandardLazyResponse, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
|
|
75
|
+
export type { ErrorEventOptions, EventDecoderOptions, EventMessage, EventMeta, HibernationEventIteratorCallback };
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { isTypescriptObject, toArray } from '@orpc/shared';
|
|
1
|
+
import { isTypescriptObject, AsyncIteratorClass, tryDecodeURIComponent, toArray, once, isAsyncIteratorObject, replicateAsyncIterator } from '@orpc/shared';
|
|
2
2
|
|
|
3
3
|
class EventEncoderError extends TypeError {
|
|
4
4
|
}
|
|
@@ -66,7 +66,6 @@ class EventDecoder {
|
|
|
66
66
|
this.options.onEvent(message);
|
|
67
67
|
}
|
|
68
68
|
}
|
|
69
|
-
this.incomplete = "";
|
|
70
69
|
}
|
|
71
70
|
end() {
|
|
72
71
|
if (this.incomplete) {
|
|
@@ -158,6 +157,9 @@ function encodeEventMessage(message) {
|
|
|
158
157
|
|
|
159
158
|
const EVENT_SOURCE_META_SYMBOL = Symbol("ORPC_EVENT_SOURCE_META");
|
|
160
159
|
function withEventMeta(container, meta) {
|
|
160
|
+
if (meta.id === void 0 && meta.retry === void 0 && !meta.comments?.length) {
|
|
161
|
+
return container;
|
|
162
|
+
}
|
|
161
163
|
if (meta.id !== void 0) {
|
|
162
164
|
assertEventId(meta.id);
|
|
163
165
|
}
|
|
@@ -182,6 +184,23 @@ function getEventMeta(container) {
|
|
|
182
184
|
return isTypescriptObject(container) ? Reflect.get(container, EVENT_SOURCE_META_SYMBOL) : void 0;
|
|
183
185
|
}
|
|
184
186
|
|
|
187
|
+
class HibernationEventIterator extends AsyncIteratorClass {
|
|
188
|
+
/**
|
|
189
|
+
* this property is not transferred to the client, so it should be optional for type safety
|
|
190
|
+
*/
|
|
191
|
+
hibernationCallback;
|
|
192
|
+
constructor(hibernationCallback) {
|
|
193
|
+
super(async () => {
|
|
194
|
+
throw new Error("Cannot iterate over hibernating iterator directly");
|
|
195
|
+
}, async (reason) => {
|
|
196
|
+
if (reason !== "next") {
|
|
197
|
+
throw new Error("Cannot cleanup hibernating iterator directly");
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
this.hibernationCallback = hibernationCallback;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
185
204
|
function generateContentDisposition(filename) {
|
|
186
205
|
const escapedFileName = filename.replace(/"/g, '\\"');
|
|
187
206
|
const encodedFilenameStar = encodeURIComponent(filename).replace(/['()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`).replace(/%(7C|60|5E)/g, (str, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
|
|
@@ -190,7 +209,7 @@ function generateContentDisposition(filename) {
|
|
|
190
209
|
function getFilenameFromContentDisposition(contentDisposition) {
|
|
191
210
|
const encodedFilenameStarMatch = contentDisposition.match(/filename\*=(UTF-8'')?([^;]*)/i);
|
|
192
211
|
if (encodedFilenameStarMatch && typeof encodedFilenameStarMatch[2] === "string") {
|
|
193
|
-
return
|
|
212
|
+
return tryDecodeURIComponent(encodedFilenameStarMatch[2]);
|
|
194
213
|
}
|
|
195
214
|
const encodedFilenameMatch = contentDisposition.match(/filename="((?:\\"|[^"])*)"/i);
|
|
196
215
|
if (encodedFilenameMatch && typeof encodedFilenameMatch[1] === "string") {
|
|
@@ -214,5 +233,36 @@ function mergeStandardHeaders(a, b) {
|
|
|
214
233
|
}
|
|
215
234
|
return merged;
|
|
216
235
|
}
|
|
236
|
+
function flattenHeader(header) {
|
|
237
|
+
if (typeof header === "string" || header === void 0) {
|
|
238
|
+
return header;
|
|
239
|
+
}
|
|
240
|
+
if (header.length === 0) {
|
|
241
|
+
return void 0;
|
|
242
|
+
}
|
|
243
|
+
return header.join(", ");
|
|
244
|
+
}
|
|
245
|
+
function replicateStandardLazyResponse(response, count) {
|
|
246
|
+
const replicated = [];
|
|
247
|
+
let bodyPromise;
|
|
248
|
+
let replicatedAsyncIteratorObjects;
|
|
249
|
+
for (let i = 0; i < count; i++) {
|
|
250
|
+
replicated.push({
|
|
251
|
+
...response,
|
|
252
|
+
body: once(async () => {
|
|
253
|
+
const body = await (bodyPromise ??= response.body());
|
|
254
|
+
if (!isAsyncIteratorObject(body)) {
|
|
255
|
+
return body;
|
|
256
|
+
}
|
|
257
|
+
replicatedAsyncIteratorObjects ??= replicateAsyncIterator(body, count);
|
|
258
|
+
return replicatedAsyncIteratorObjects.shift();
|
|
259
|
+
})
|
|
260
|
+
});
|
|
261
|
+
}
|
|
262
|
+
return replicated;
|
|
263
|
+
}
|
|
264
|
+
function isEventIteratorHeaders(headers) {
|
|
265
|
+
return Boolean(flattenHeader(headers["content-type"])?.startsWith("text/event-stream") && flattenHeader(headers["content-disposition"]) === void 0);
|
|
266
|
+
}
|
|
217
267
|
|
|
218
|
-
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, mergeStandardHeaders, withEventMeta };
|
|
268
|
+
export { ErrorEvent, EventDecoder, EventDecoderError, EventDecoderStream, EventEncoderError, HibernationEventIterator, assertEventComment, assertEventId, assertEventName, assertEventRetry, decodeEventMessage, encodeEventComments, encodeEventData, encodeEventMessage, flattenHeader, generateContentDisposition, getEventMeta, getFilenameFromContentDisposition, isEventIteratorHeaders, mergeStandardHeaders, replicateStandardLazyResponse, withEventMeta };
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
interface StandardHeaders {
|
|
2
|
+
[key: string]: string | string[] | undefined;
|
|
3
|
+
}
|
|
4
|
+
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
5
|
+
interface StandardRequest {
|
|
6
|
+
method: string;
|
|
7
|
+
url: URL;
|
|
8
|
+
headers: StandardHeaders;
|
|
9
|
+
/**
|
|
10
|
+
* The body has been parsed based on the content-type header.
|
|
11
|
+
*/
|
|
12
|
+
body: StandardBody;
|
|
13
|
+
signal: AbortSignal | undefined;
|
|
14
|
+
}
|
|
15
|
+
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
16
|
+
/**
|
|
17
|
+
* The body has been parsed based on the content-type header.
|
|
18
|
+
* This method can safely call multiple times (cached).
|
|
19
|
+
*/
|
|
20
|
+
body: () => Promise<StandardBody>;
|
|
21
|
+
}
|
|
22
|
+
interface StandardResponse {
|
|
23
|
+
status: number;
|
|
24
|
+
headers: StandardHeaders;
|
|
25
|
+
/**
|
|
26
|
+
* The body has been parsed based on the content-type header.
|
|
27
|
+
*/
|
|
28
|
+
body: StandardBody;
|
|
29
|
+
}
|
|
30
|
+
interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
|
|
31
|
+
/**
|
|
32
|
+
* The body has been parsed based on the content-type header.
|
|
33
|
+
* This method can safely call multiple times (cached).
|
|
34
|
+
*/
|
|
35
|
+
body: () => Promise<StandardBody>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
interface StandardHeaders {
|
|
2
|
+
[key: string]: string | string[] | undefined;
|
|
3
|
+
}
|
|
4
|
+
type StandardBody = undefined | unknown | Blob | URLSearchParams | FormData | AsyncIterator<unknown | void, unknown | void, undefined>;
|
|
5
|
+
interface StandardRequest {
|
|
6
|
+
method: string;
|
|
7
|
+
url: URL;
|
|
8
|
+
headers: StandardHeaders;
|
|
9
|
+
/**
|
|
10
|
+
* The body has been parsed based on the content-type header.
|
|
11
|
+
*/
|
|
12
|
+
body: StandardBody;
|
|
13
|
+
signal: AbortSignal | undefined;
|
|
14
|
+
}
|
|
15
|
+
interface StandardLazyRequest extends Omit<StandardRequest, 'body'> {
|
|
16
|
+
/**
|
|
17
|
+
* The body has been parsed based on the content-type header.
|
|
18
|
+
* This method can safely call multiple times (cached).
|
|
19
|
+
*/
|
|
20
|
+
body: () => Promise<StandardBody>;
|
|
21
|
+
}
|
|
22
|
+
interface StandardResponse {
|
|
23
|
+
status: number;
|
|
24
|
+
headers: StandardHeaders;
|
|
25
|
+
/**
|
|
26
|
+
* The body has been parsed based on the content-type header.
|
|
27
|
+
*/
|
|
28
|
+
body: StandardBody;
|
|
29
|
+
}
|
|
30
|
+
interface StandardLazyResponse extends Omit<StandardResponse, 'body'> {
|
|
31
|
+
/**
|
|
32
|
+
* The body has been parsed based on the content-type header.
|
|
33
|
+
* This method can safely call multiple times (cached).
|
|
34
|
+
*/
|
|
35
|
+
body: () => Promise<StandardBody>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export type { StandardHeaders as S, StandardLazyResponse as a, StandardBody as b, StandardRequest as c, StandardLazyRequest as d, StandardResponse as e };
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/standard-server",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.6bc474e",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"homepage": "https://
|
|
6
|
+
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/
|
|
9
|
+
"url": "git+https://github.com/middleapi/orpc.git",
|
|
10
10
|
"directory": "packages/standard-server"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
@@ -17,13 +17,18 @@
|
|
|
17
17
|
"types": "./dist/index.d.mts",
|
|
18
18
|
"import": "./dist/index.mjs",
|
|
19
19
|
"default": "./dist/index.mjs"
|
|
20
|
+
},
|
|
21
|
+
"./batch": {
|
|
22
|
+
"types": "./dist/batch/index.d.mts",
|
|
23
|
+
"import": "./dist/batch/index.mjs",
|
|
24
|
+
"default": "./dist/batch/index.mjs"
|
|
20
25
|
}
|
|
21
26
|
},
|
|
22
27
|
"files": [
|
|
23
28
|
"dist"
|
|
24
29
|
],
|
|
25
30
|
"dependencies": {
|
|
26
|
-
"@orpc/shared": "0.0.0-next.
|
|
31
|
+
"@orpc/shared": "0.0.0-next.6bc474e"
|
|
27
32
|
},
|
|
28
33
|
"scripts": {
|
|
29
34
|
"build": "unbuild",
|