@orpc/node 2.0.0-beta.25
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/LICENSE +21 -0
- package/README.md +203 -0
- package/dist/index.d.mts +130 -0
- package/dist/index.d.ts +130 -0
- package/dist/index.mjs +328 -0
- package/package.json +42 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 oRPC
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
<h1 align="center">oRPC - Typesafe APIs Made Simple πͺ</h1>
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
5
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://www.npmjs.com/package/@orpc/node">
|
|
8
|
+
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fnode?logo=npm" />
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
|
|
11
|
+
<img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
|
|
12
|
+
</a>
|
|
13
|
+
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
14
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
15
|
+
</a>
|
|
16
|
+
<a href="https://discord.gg/TXEbwRBvQn">
|
|
17
|
+
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
18
|
+
</a>
|
|
19
|
+
<a href="https://deepwiki.com/middleapi/orpc">
|
|
20
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
21
|
+
</a>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
## Documentation
|
|
25
|
+
|
|
26
|
+
You can read the documentation [here](https://orpc.dev).
|
|
27
|
+
|
|
28
|
+
## Packages
|
|
29
|
+
|
|
30
|
+
**Core**
|
|
31
|
+
|
|
32
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
|
|
33
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
34
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
35
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
36
|
+
|
|
37
|
+
**Schema validation**
|
|
38
|
+
|
|
39
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
|
|
40
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
41
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
42
|
+
|
|
43
|
+
**Built-in features**
|
|
44
|
+
|
|
45
|
+
- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
|
|
46
|
+
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
47
|
+
- [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation): Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api).
|
|
48
|
+
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
49
|
+
|
|
50
|
+
**Framework & ecosystem integrations**
|
|
51
|
+
|
|
52
|
+
- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
|
|
53
|
+
- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
54
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
55
|
+
- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
56
|
+
- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
|
|
57
|
+
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
58
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
59
|
+
- [@orpc/node](https://www.npmjs.com/package/@orpc/node): [Node.js](https://nodejs.org/) plugins, helpers, like serving static files.
|
|
60
|
+
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
61
|
+
- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
|
|
62
|
+
- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
63
|
+
|
|
64
|
+
**Observability**
|
|
65
|
+
|
|
66
|
+
- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
|
|
67
|
+
- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
|
|
68
|
+
- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
|
|
69
|
+
|
|
70
|
+
## Sponsors
|
|
71
|
+
|
|
72
|
+
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! π
|
|
73
|
+
|
|
74
|
+
### π Platinum Sponsor
|
|
75
|
+
|
|
76
|
+
<table>
|
|
77
|
+
<tr>
|
|
78
|
+
<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>
|
|
79
|
+
</tr>
|
|
80
|
+
</table>
|
|
81
|
+
|
|
82
|
+
### π₯ Silver Sponsor
|
|
83
|
+
|
|
84
|
+
<table>
|
|
85
|
+
<tr>
|
|
86
|
+
<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="209" alt="ζδΈγγ"/><br />ζδΈγγ</a></td>
|
|
87
|
+
</tr>
|
|
88
|
+
</table>
|
|
89
|
+
|
|
90
|
+
### Generous Sponsors
|
|
91
|
+
|
|
92
|
+
<table>
|
|
93
|
+
<tr>
|
|
94
|
+
<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>
|
|
95
|
+
</tr>
|
|
96
|
+
</table>
|
|
97
|
+
|
|
98
|
+
### Sponsors
|
|
99
|
+
|
|
100
|
+
<table>
|
|
101
|
+
<tr>
|
|
102
|
+
<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>
|
|
103
|
+
<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>
|
|
104
|
+
<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>
|
|
105
|
+
<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>
|
|
106
|
+
<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>
|
|
107
|
+
<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>
|
|
108
|
+
</tr>
|
|
109
|
+
<tr>
|
|
110
|
+
<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>
|
|
111
|
+
<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>
|
|
112
|
+
<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>
|
|
113
|
+
<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>
|
|
114
|
+
<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>
|
|
115
|
+
<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>
|
|
116
|
+
</tr>
|
|
117
|
+
<tr>
|
|
118
|
+
<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>
|
|
119
|
+
<td align="center"><a href="https://github.com/ellis-driscoll?ref=orpc" target="_blank" rel="noopener" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
|
|
120
|
+
</tr>
|
|
121
|
+
</table>
|
|
122
|
+
|
|
123
|
+
### Backers
|
|
124
|
+
|
|
125
|
+
<table>
|
|
126
|
+
<tr>
|
|
127
|
+
<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>
|
|
128
|
+
<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>
|
|
129
|
+
<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>
|
|
130
|
+
<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>
|
|
131
|
+
<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>
|
|
132
|
+
<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>
|
|
133
|
+
<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>
|
|
134
|
+
</tr>
|
|
135
|
+
<tr>
|
|
136
|
+
<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>
|
|
137
|
+
<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>
|
|
138
|
+
<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>
|
|
139
|
+
<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>
|
|
140
|
+
<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>
|
|
141
|
+
<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>
|
|
142
|
+
<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>
|
|
143
|
+
</tr>
|
|
144
|
+
<tr>
|
|
145
|
+
<td align="center"><a href="https://github.com/guyariely?ref=orpc" target="_blank" rel="noopener" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
|
|
146
|
+
<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>
|
|
147
|
+
<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=c5f2daf7ebece498e85c83367bb37b4e10e2649d&v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
|
|
148
|
+
</tr>
|
|
149
|
+
</table>
|
|
150
|
+
|
|
151
|
+
### Past Sponsors
|
|
152
|
+
|
|
153
|
+
<p>
|
|
154
|
+
<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>
|
|
155
|
+
<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>
|
|
156
|
+
<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="32" height="32" alt="γγγγγ¨γΌγ«γ
" /></a>
|
|
157
|
+
<a href="https://github.com/zuplo?ref=orpc" target="_blank" rel="noopener" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="32" height="32" alt="Zuplo" /></a>
|
|
158
|
+
<a href="https://github.com/motopods?ref=orpc" target="_blank" rel="noopener" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?v=4" width="32" height="32" alt="motopods" /></a>
|
|
159
|
+
<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>
|
|
160
|
+
<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>
|
|
161
|
+
<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>
|
|
162
|
+
<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>
|
|
163
|
+
<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>
|
|
164
|
+
<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>
|
|
165
|
+
<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>
|
|
166
|
+
<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>
|
|
167
|
+
<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>
|
|
168
|
+
<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>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<a href="https://github.com/bapspatil?ref=orpc" target="_blank" rel="noopener" title="Bapusaheb Patil"><img src="https://avatars.githubusercontent.com/u/16699418?u=6d9d8e0a64a6f91ca1c4d559c72d931172bdcbbd&v=4" width="32" height="32" alt="Bapusaheb Patil" /></a>
|
|
173
|
+
<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>
|
|
174
|
+
<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>
|
|
175
|
+
<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>
|
|
176
|
+
<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>
|
|
177
|
+
<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="32" height="32" alt="Andrew Peters" /></a>
|
|
178
|
+
<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="32" height="32" alt="Ryan Vogel" /></a>
|
|
179
|
+
<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>
|
|
180
|
+
<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="32" height="32" alt="Peter Adam" /></a>
|
|
181
|
+
<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>
|
|
182
|
+
<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>
|
|
183
|
+
<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>
|
|
184
|
+
<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>
|
|
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/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>
|
|
187
|
+
<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>
|
|
188
|
+
<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>
|
|
189
|
+
<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>
|
|
190
|
+
<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>
|
|
191
|
+
<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="32" height="32" alt="Nicholas" /></a>
|
|
192
|
+
</p>
|
|
193
|
+
|
|
194
|
+
## References
|
|
195
|
+
|
|
196
|
+
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
197
|
+
|
|
198
|
+
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
199
|
+
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
200
|
+
|
|
201
|
+
## License
|
|
202
|
+
|
|
203
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { Context } from '@orpc/server';
|
|
2
|
+
import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
3
|
+
|
|
4
|
+
interface StaticFileHandlerPluginOptions {
|
|
5
|
+
/**
|
|
6
|
+
* The directory files are served from. Resolved against the working
|
|
7
|
+
* directory when relative.
|
|
8
|
+
*/
|
|
9
|
+
rootDir: string;
|
|
10
|
+
/**
|
|
11
|
+
* The URL path files are served under, appended to the handler prefix
|
|
12
|
+
* when one is set.
|
|
13
|
+
*
|
|
14
|
+
* @default '/'
|
|
15
|
+
*/
|
|
16
|
+
path?: `/${string}`;
|
|
17
|
+
/**
|
|
18
|
+
* The file served when the request path resolves to a directory.
|
|
19
|
+
* Set to `false` to disable directory index files.
|
|
20
|
+
*
|
|
21
|
+
* @default 'index.html'
|
|
22
|
+
*/
|
|
23
|
+
indexFile?: string | false;
|
|
24
|
+
/**
|
|
25
|
+
* A file served with status 200 when no file matches the request path,
|
|
26
|
+
* relative to `rootDir`. Useful for single-page application routing.
|
|
27
|
+
*
|
|
28
|
+
* @default undefined
|
|
29
|
+
*/
|
|
30
|
+
fallbackFile?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The `Cache-Control` response header value. Set to `false` to omit the header.
|
|
33
|
+
*
|
|
34
|
+
* @default 'public, max-age=0'
|
|
35
|
+
*/
|
|
36
|
+
cacheControl?: string | false;
|
|
37
|
+
/**
|
|
38
|
+
* Whether files and directories whose name starts with a dot can be served.
|
|
39
|
+
*
|
|
40
|
+
* @default false
|
|
41
|
+
*/
|
|
42
|
+
dotfiles?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Whether precompressed sidecar files (`.br`, `.zst`, `.gz`) can be served
|
|
45
|
+
* when the client accepts their encoding and the content type is compressible.
|
|
46
|
+
*
|
|
47
|
+
* @default false
|
|
48
|
+
*/
|
|
49
|
+
precompressed?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Whether symbolic links whose target lies outside `rootDir` can be served.
|
|
52
|
+
* Enabling this makes every file the links reach publicly readable.
|
|
53
|
+
*
|
|
54
|
+
* @default false
|
|
55
|
+
*/
|
|
56
|
+
allowSymlinks?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Content types keyed by lowercase file extension without the dot, taking precedence over
|
|
59
|
+
* the type detected from the extension. Values are sent verbatim, so a text type needs its
|
|
60
|
+
* own charset. Extensions that neither this nor the detection recognises are served as
|
|
61
|
+
* `application/octet-stream`.
|
|
62
|
+
*/
|
|
63
|
+
mimeTypes?: Record<string, string>;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Serves static files from a directory with standard HTTP semantics:
|
|
67
|
+
* `ETag`/`Last-Modified` conditional requests, range requests, index files,
|
|
68
|
+
* and directory traversal protection. Files are served as a fallback,
|
|
69
|
+
* so matched procedures always win.
|
|
70
|
+
*
|
|
71
|
+
* @remarks
|
|
72
|
+
* Deliberate deviations, all matching `send`, nginx, and Hono: range handling applies to `GET`
|
|
73
|
+
* only, so `HEAD` always reports the full length even though `Accept-Ranges` advertises support;
|
|
74
|
+
* a suffix range against an empty file answers `416`; and `dotfiles` is a request-path policy,
|
|
75
|
+
* so it never applies to a configured `indexFile` or `fallbackFile`.
|
|
76
|
+
*
|
|
77
|
+
* @see {@link https://orpc.dev/docs/plugins/static-file | Static File Plugin}
|
|
78
|
+
*/
|
|
79
|
+
declare class StaticFileHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
80
|
+
name: string;
|
|
81
|
+
/**
|
|
82
|
+
* Ensure the OpenTelemetry span is available when the interceptor renames it.
|
|
83
|
+
*/
|
|
84
|
+
after: string[];
|
|
85
|
+
private readonly rootDir;
|
|
86
|
+
/** `rootDir` with a trailing separator, precomputed for the lexical containment check. */
|
|
87
|
+
private readonly rootDirPrefix;
|
|
88
|
+
/**
|
|
89
|
+
* `rootDir` with its own symbolic links resolved, paired with its trailing separator form.
|
|
90
|
+
* Resolved once, so a symlinked `rootDir` keeps working and platform links like the macOS
|
|
91
|
+
* `/var` to `/private/var` do not reject every file.
|
|
92
|
+
*/
|
|
93
|
+
private readonly rootDirRealPaths;
|
|
94
|
+
private readonly path;
|
|
95
|
+
private readonly indexFile;
|
|
96
|
+
private readonly fallbackFile;
|
|
97
|
+
private readonly cacheControl;
|
|
98
|
+
private readonly dotfiles;
|
|
99
|
+
private readonly precompressed;
|
|
100
|
+
private readonly allowSymlinks;
|
|
101
|
+
private readonly mimeTypes;
|
|
102
|
+
constructor(options: StaticFileHandlerPluginOptions);
|
|
103
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
104
|
+
/**
|
|
105
|
+
* Joins segments under `rootDir` and guarantees the result cannot escape it,
|
|
106
|
+
* as a second layer of defense after URL segment validation.
|
|
107
|
+
*/
|
|
108
|
+
private resolveWithinRoot;
|
|
109
|
+
/**
|
|
110
|
+
* Resolves symbolic links and confirms the target is still inside the root,
|
|
111
|
+
* which the lexical `resolveWithinRoot` check cannot see.
|
|
112
|
+
*/
|
|
113
|
+
private resolveContainedRealPath;
|
|
114
|
+
private resolveContentType;
|
|
115
|
+
private resolveBasePath;
|
|
116
|
+
/**
|
|
117
|
+
* Resolves segments under `rootDir` and stats the result, rejecting anything that
|
|
118
|
+
* escapes the root either lexically or by following a symbolic link.
|
|
119
|
+
*/
|
|
120
|
+
private lookup;
|
|
121
|
+
/**
|
|
122
|
+
* Normalizes the url path into filesystem segments,
|
|
123
|
+
* returning `undefined` when the request can never map to a servable file.
|
|
124
|
+
*/
|
|
125
|
+
private resolveSegments;
|
|
126
|
+
private serve;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export { StaticFileHandlerPlugin };
|
|
130
|
+
export type { StaticFileHandlerPluginOptions };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { Context } from '@orpc/server';
|
|
2
|
+
import { StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
3
|
+
|
|
4
|
+
interface StaticFileHandlerPluginOptions {
|
|
5
|
+
/**
|
|
6
|
+
* The directory files are served from. Resolved against the working
|
|
7
|
+
* directory when relative.
|
|
8
|
+
*/
|
|
9
|
+
rootDir: string;
|
|
10
|
+
/**
|
|
11
|
+
* The URL path files are served under, appended to the handler prefix
|
|
12
|
+
* when one is set.
|
|
13
|
+
*
|
|
14
|
+
* @default '/'
|
|
15
|
+
*/
|
|
16
|
+
path?: `/${string}`;
|
|
17
|
+
/**
|
|
18
|
+
* The file served when the request path resolves to a directory.
|
|
19
|
+
* Set to `false` to disable directory index files.
|
|
20
|
+
*
|
|
21
|
+
* @default 'index.html'
|
|
22
|
+
*/
|
|
23
|
+
indexFile?: string | false;
|
|
24
|
+
/**
|
|
25
|
+
* A file served with status 200 when no file matches the request path,
|
|
26
|
+
* relative to `rootDir`. Useful for single-page application routing.
|
|
27
|
+
*
|
|
28
|
+
* @default undefined
|
|
29
|
+
*/
|
|
30
|
+
fallbackFile?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The `Cache-Control` response header value. Set to `false` to omit the header.
|
|
33
|
+
*
|
|
34
|
+
* @default 'public, max-age=0'
|
|
35
|
+
*/
|
|
36
|
+
cacheControl?: string | false;
|
|
37
|
+
/**
|
|
38
|
+
* Whether files and directories whose name starts with a dot can be served.
|
|
39
|
+
*
|
|
40
|
+
* @default false
|
|
41
|
+
*/
|
|
42
|
+
dotfiles?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Whether precompressed sidecar files (`.br`, `.zst`, `.gz`) can be served
|
|
45
|
+
* when the client accepts their encoding and the content type is compressible.
|
|
46
|
+
*
|
|
47
|
+
* @default false
|
|
48
|
+
*/
|
|
49
|
+
precompressed?: boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Whether symbolic links whose target lies outside `rootDir` can be served.
|
|
52
|
+
* Enabling this makes every file the links reach publicly readable.
|
|
53
|
+
*
|
|
54
|
+
* @default false
|
|
55
|
+
*/
|
|
56
|
+
allowSymlinks?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Content types keyed by lowercase file extension without the dot, taking precedence over
|
|
59
|
+
* the type detected from the extension. Values are sent verbatim, so a text type needs its
|
|
60
|
+
* own charset. Extensions that neither this nor the detection recognises are served as
|
|
61
|
+
* `application/octet-stream`.
|
|
62
|
+
*/
|
|
63
|
+
mimeTypes?: Record<string, string>;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Serves static files from a directory with standard HTTP semantics:
|
|
67
|
+
* `ETag`/`Last-Modified` conditional requests, range requests, index files,
|
|
68
|
+
* and directory traversal protection. Files are served as a fallback,
|
|
69
|
+
* so matched procedures always win.
|
|
70
|
+
*
|
|
71
|
+
* @remarks
|
|
72
|
+
* Deliberate deviations, all matching `send`, nginx, and Hono: range handling applies to `GET`
|
|
73
|
+
* only, so `HEAD` always reports the full length even though `Accept-Ranges` advertises support;
|
|
74
|
+
* a suffix range against an empty file answers `416`; and `dotfiles` is a request-path policy,
|
|
75
|
+
* so it never applies to a configured `indexFile` or `fallbackFile`.
|
|
76
|
+
*
|
|
77
|
+
* @see {@link https://orpc.dev/docs/plugins/static-file | Static File Plugin}
|
|
78
|
+
*/
|
|
79
|
+
declare class StaticFileHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
80
|
+
name: string;
|
|
81
|
+
/**
|
|
82
|
+
* Ensure the OpenTelemetry span is available when the interceptor renames it.
|
|
83
|
+
*/
|
|
84
|
+
after: string[];
|
|
85
|
+
private readonly rootDir;
|
|
86
|
+
/** `rootDir` with a trailing separator, precomputed for the lexical containment check. */
|
|
87
|
+
private readonly rootDirPrefix;
|
|
88
|
+
/**
|
|
89
|
+
* `rootDir` with its own symbolic links resolved, paired with its trailing separator form.
|
|
90
|
+
* Resolved once, so a symlinked `rootDir` keeps working and platform links like the macOS
|
|
91
|
+
* `/var` to `/private/var` do not reject every file.
|
|
92
|
+
*/
|
|
93
|
+
private readonly rootDirRealPaths;
|
|
94
|
+
private readonly path;
|
|
95
|
+
private readonly indexFile;
|
|
96
|
+
private readonly fallbackFile;
|
|
97
|
+
private readonly cacheControl;
|
|
98
|
+
private readonly dotfiles;
|
|
99
|
+
private readonly precompressed;
|
|
100
|
+
private readonly allowSymlinks;
|
|
101
|
+
private readonly mimeTypes;
|
|
102
|
+
constructor(options: StaticFileHandlerPluginOptions);
|
|
103
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
104
|
+
/**
|
|
105
|
+
* Joins segments under `rootDir` and guarantees the result cannot escape it,
|
|
106
|
+
* as a second layer of defense after URL segment validation.
|
|
107
|
+
*/
|
|
108
|
+
private resolveWithinRoot;
|
|
109
|
+
/**
|
|
110
|
+
* Resolves symbolic links and confirms the target is still inside the root,
|
|
111
|
+
* which the lexical `resolveWithinRoot` check cannot see.
|
|
112
|
+
*/
|
|
113
|
+
private resolveContainedRealPath;
|
|
114
|
+
private resolveContentType;
|
|
115
|
+
private resolveBasePath;
|
|
116
|
+
/**
|
|
117
|
+
* Resolves segments under `rootDir` and stats the result, rejecting anything that
|
|
118
|
+
* escapes the root either lexically or by following a symbolic link.
|
|
119
|
+
*/
|
|
120
|
+
private lookup;
|
|
121
|
+
/**
|
|
122
|
+
* Normalizes the url path into filesystem segments,
|
|
123
|
+
* returning `undefined` when the request can never map to a servable file.
|
|
124
|
+
*/
|
|
125
|
+
private resolveSegments;
|
|
126
|
+
private serve;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
export { StaticFileHandlerPlugin };
|
|
130
|
+
export type { StaticFileHandlerPluginOptions };
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
import { createReadStream } from 'node:fs';
|
|
2
|
+
import { realpath, stat } from 'node:fs/promises';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { Readable } from 'node:stream';
|
|
5
|
+
import { toArray, mergeHttpPath, tryDecodeURIComponent, matchesHttpPathPrefix, isCompressibleContentType, parseAcceptEncodingQualities, getOpenTelemetryConfig } from '@orpc/shared';
|
|
6
|
+
import { parseStandardUrl, flattenStandardHeader } from '@standardserver/core';
|
|
7
|
+
import mime from 'mime';
|
|
8
|
+
|
|
9
|
+
const TEXT_CONTENT_TYPE_REGEX = /^text\//;
|
|
10
|
+
const PRECOMPRESSED_ENCODINGS = [
|
|
11
|
+
["br", ".br"],
|
|
12
|
+
["zstd", ".zst"],
|
|
13
|
+
["gzip", ".gz"]
|
|
14
|
+
];
|
|
15
|
+
class StaticFileHandlerPlugin {
|
|
16
|
+
name = "~static-file";
|
|
17
|
+
/**
|
|
18
|
+
* Ensure the OpenTelemetry span is available when the interceptor renames it.
|
|
19
|
+
*/
|
|
20
|
+
after = ["~opentelemetry"];
|
|
21
|
+
rootDir;
|
|
22
|
+
/** `rootDir` with a trailing separator, precomputed for the lexical containment check. */
|
|
23
|
+
rootDirPrefix;
|
|
24
|
+
/**
|
|
25
|
+
* `rootDir` with its own symbolic links resolved, paired with its trailing separator form.
|
|
26
|
+
* Resolved once, so a symlinked `rootDir` keeps working and platform links like the macOS
|
|
27
|
+
* `/var` to `/private/var` do not reject every file.
|
|
28
|
+
*/
|
|
29
|
+
rootDirRealPaths;
|
|
30
|
+
path;
|
|
31
|
+
indexFile;
|
|
32
|
+
fallbackFile;
|
|
33
|
+
cacheControl;
|
|
34
|
+
dotfiles;
|
|
35
|
+
precompressed;
|
|
36
|
+
allowSymlinks;
|
|
37
|
+
mimeTypes;
|
|
38
|
+
constructor(options) {
|
|
39
|
+
this.rootDir = path.resolve(options.rootDir);
|
|
40
|
+
this.rootDirPrefix = this.rootDir.endsWith(path.sep) ? this.rootDir : this.rootDir + path.sep;
|
|
41
|
+
this.rootDirRealPaths = realpath(this.rootDir).catch(() => this.rootDir).then((rootDirReal) => [rootDirReal, rootDirReal.endsWith(path.sep) ? rootDirReal : rootDirReal + path.sep]);
|
|
42
|
+
this.path = stripTrailingSlash(options.path ?? "/");
|
|
43
|
+
this.indexFile = options.indexFile ?? "index.html";
|
|
44
|
+
this.fallbackFile = options.fallbackFile;
|
|
45
|
+
this.cacheControl = options.cacheControl ?? "public, max-age=0";
|
|
46
|
+
this.dotfiles = options.dotfiles ?? false;
|
|
47
|
+
this.precompressed = options.precompressed ?? false;
|
|
48
|
+
this.allowSymlinks = options.allowSymlinks ?? false;
|
|
49
|
+
this.mimeTypes = Object.assign(/* @__PURE__ */ Object.create(null), options.mimeTypes);
|
|
50
|
+
}
|
|
51
|
+
init(options) {
|
|
52
|
+
const routingInterceptor = async ({ next, request, prefix }) => {
|
|
53
|
+
const result = await next();
|
|
54
|
+
if (result.matched || request.method !== "GET" && request.method !== "HEAD") {
|
|
55
|
+
return result;
|
|
56
|
+
}
|
|
57
|
+
const base = this.resolveBasePath(prefix);
|
|
58
|
+
const response = await this.serve(request, base);
|
|
59
|
+
if (response === void 0) {
|
|
60
|
+
return result;
|
|
61
|
+
}
|
|
62
|
+
getOpenTelemetryConfig()?.trace.getActiveSpan()?.updateName(`${request.method} ${base === "/" ? "" : base}/* (static file)`);
|
|
63
|
+
return { matched: true, response };
|
|
64
|
+
};
|
|
65
|
+
return {
|
|
66
|
+
...options,
|
|
67
|
+
// Run after user-provided routing interceptors so they can capture file responses
|
|
68
|
+
routingInterceptors: [...toArray(options.routingInterceptors), routingInterceptor]
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Joins segments under `rootDir` and guarantees the result cannot escape it,
|
|
73
|
+
* as a second layer of defense after URL segment validation.
|
|
74
|
+
*/
|
|
75
|
+
resolveWithinRoot(segments) {
|
|
76
|
+
const resolved = path.join(this.rootDir, ...segments);
|
|
77
|
+
if (resolved !== this.rootDir && !resolved.startsWith(this.rootDirPrefix)) {
|
|
78
|
+
return void 0;
|
|
79
|
+
}
|
|
80
|
+
return resolved;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Resolves symbolic links and confirms the target is still inside the root,
|
|
84
|
+
* which the lexical `resolveWithinRoot` check cannot see.
|
|
85
|
+
*/
|
|
86
|
+
async resolveContainedRealPath(filePath) {
|
|
87
|
+
if (this.allowSymlinks) {
|
|
88
|
+
return filePath;
|
|
89
|
+
}
|
|
90
|
+
const [rootDirReal, rootDirRealPrefix] = await this.rootDirRealPaths;
|
|
91
|
+
const realPath = await realpath(filePath).catch(() => "");
|
|
92
|
+
return realPath === rootDirReal || realPath.startsWith(rootDirRealPrefix) ? realPath : void 0;
|
|
93
|
+
}
|
|
94
|
+
resolveContentType(filePath) {
|
|
95
|
+
const extension = path.extname(filePath).slice(1).toLowerCase();
|
|
96
|
+
const configured = this.mimeTypes[extension];
|
|
97
|
+
if (configured !== void 0) {
|
|
98
|
+
return configured;
|
|
99
|
+
}
|
|
100
|
+
const contentType = mime.getType(extension);
|
|
101
|
+
if (contentType === null) {
|
|
102
|
+
return "application/octet-stream";
|
|
103
|
+
}
|
|
104
|
+
return TEXT_CONTENT_TYPE_REGEX.test(contentType) ? `${contentType}; charset=utf-8` : contentType;
|
|
105
|
+
}
|
|
106
|
+
resolveBasePath(prefix) {
|
|
107
|
+
return prefix === void 0 ? this.path : stripTrailingSlash(mergeHttpPath(prefix, this.path));
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Resolves segments under `rootDir` and stats the result, rejecting anything that
|
|
111
|
+
* escapes the root either lexically or by following a symbolic link.
|
|
112
|
+
*/
|
|
113
|
+
async lookup(segments) {
|
|
114
|
+
const filePath = this.resolveWithinRoot(segments);
|
|
115
|
+
if (filePath === void 0) {
|
|
116
|
+
return void 0;
|
|
117
|
+
}
|
|
118
|
+
const [stats, containedRealPath] = await Promise.all([
|
|
119
|
+
stat(filePath).catch(() => void 0),
|
|
120
|
+
this.resolveContainedRealPath(filePath)
|
|
121
|
+
]);
|
|
122
|
+
if (stats === void 0 || containedRealPath === void 0) {
|
|
123
|
+
return void 0;
|
|
124
|
+
}
|
|
125
|
+
return [filePath, stats];
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Normalizes the url path into filesystem segments,
|
|
129
|
+
* returning `undefined` when the request can never map to a servable file.
|
|
130
|
+
*/
|
|
131
|
+
resolveSegments(pathname, base) {
|
|
132
|
+
const segments = [];
|
|
133
|
+
for (const rawSegment of pathname.slice(base.length).split("/")) {
|
|
134
|
+
const segment = rawSegment.includes("%") ? tryDecodeURIComponent(rawSegment) : rawSegment;
|
|
135
|
+
if (segment === "" || segment === ".") {
|
|
136
|
+
continue;
|
|
137
|
+
}
|
|
138
|
+
if (segment === "..") {
|
|
139
|
+
if (segments.length === 0) {
|
|
140
|
+
return void 0;
|
|
141
|
+
}
|
|
142
|
+
segments.pop();
|
|
143
|
+
continue;
|
|
144
|
+
}
|
|
145
|
+
if (segment.includes("\0") || segment.includes("/") || segment.includes("\\")) {
|
|
146
|
+
return void 0;
|
|
147
|
+
}
|
|
148
|
+
if (!this.dotfiles && segment.startsWith(".")) {
|
|
149
|
+
return void 0;
|
|
150
|
+
}
|
|
151
|
+
segments.push(segment);
|
|
152
|
+
}
|
|
153
|
+
return segments;
|
|
154
|
+
}
|
|
155
|
+
async serve(request, base) {
|
|
156
|
+
const [pathname, search] = parseStandardUrl(request.url);
|
|
157
|
+
if (base !== "/" && !matchesHttpPathPrefix(pathname, base)) {
|
|
158
|
+
return void 0;
|
|
159
|
+
}
|
|
160
|
+
const segments = this.resolveSegments(pathname, base);
|
|
161
|
+
if (segments === void 0) {
|
|
162
|
+
return void 0;
|
|
163
|
+
}
|
|
164
|
+
let found;
|
|
165
|
+
if (pathname.endsWith("/")) {
|
|
166
|
+
found = this.indexFile === false ? void 0 : await this.lookup([...segments, this.indexFile]);
|
|
167
|
+
} else {
|
|
168
|
+
found = await this.lookup(segments);
|
|
169
|
+
if (found?.[1].isDirectory()) {
|
|
170
|
+
if (this.indexFile === false) {
|
|
171
|
+
found = void 0;
|
|
172
|
+
} else {
|
|
173
|
+
const location = `${base === "/" ? "" : base}${segments.map((segment) => `/${encodeURIComponent(segment)}`).join("")}/`;
|
|
174
|
+
return {
|
|
175
|
+
status: 301,
|
|
176
|
+
headers: {
|
|
177
|
+
location: `${location}${search ?? ""}`,
|
|
178
|
+
...this.cacheControl === false ? {} : { "cache-control": this.cacheControl }
|
|
179
|
+
}
|
|
180
|
+
};
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
if (found === void 0 || !found[1].isFile()) {
|
|
185
|
+
if (this.fallbackFile === void 0) {
|
|
186
|
+
return void 0;
|
|
187
|
+
}
|
|
188
|
+
found = await this.lookup([this.fallbackFile]);
|
|
189
|
+
if (found === void 0 || !found[1].isFile()) {
|
|
190
|
+
return void 0;
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
let [filePath, stats] = found;
|
|
194
|
+
const contentType = this.resolveContentType(filePath);
|
|
195
|
+
const negotiatesEncoding = this.precompressed && isCompressibleContentType(contentType);
|
|
196
|
+
let contentEncoding;
|
|
197
|
+
if (negotiatesEncoding) {
|
|
198
|
+
const qualities = parseAcceptEncodingQualities(flattenStandardHeader(request.headers["accept-encoding"]));
|
|
199
|
+
const variants = await Promise.all(PRECOMPRESSED_ENCODINGS.filter(([encoding]) => (qualities.get(encoding) ?? qualities.get("*") ?? 0) > 0).map(async ([encoding, extension]) => {
|
|
200
|
+
const candidatePath = filePath + extension;
|
|
201
|
+
const [candidateStats, containedRealPath] = await Promise.all([
|
|
202
|
+
stat(candidatePath).catch(() => void 0),
|
|
203
|
+
this.resolveContainedRealPath(candidatePath)
|
|
204
|
+
]);
|
|
205
|
+
return candidateStats?.isFile() && containedRealPath !== void 0 ? { encoding, extension, stats: candidateStats } : void 0;
|
|
206
|
+
}));
|
|
207
|
+
const variant = variants.find((variant2) => variant2 !== void 0);
|
|
208
|
+
if (variant !== void 0) {
|
|
209
|
+
filePath += variant.extension;
|
|
210
|
+
stats = variant.stats;
|
|
211
|
+
contentEncoding = variant.encoding;
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
const size = stats.size;
|
|
215
|
+
const etag = `"${size.toString(16)}-${stats.mtime.getTime().toString(16)}"`;
|
|
216
|
+
const lastModifiedTime = Math.floor(stats.mtime.getTime() / 1e3) * 1e3;
|
|
217
|
+
const headers = {
|
|
218
|
+
"etag": etag,
|
|
219
|
+
"last-modified": stats.mtime.toUTCString(),
|
|
220
|
+
"accept-ranges": "bytes"
|
|
221
|
+
};
|
|
222
|
+
if (negotiatesEncoding) {
|
|
223
|
+
headers.vary = "accept-encoding";
|
|
224
|
+
}
|
|
225
|
+
if (this.cacheControl !== false) {
|
|
226
|
+
headers["cache-control"] = this.cacheControl;
|
|
227
|
+
}
|
|
228
|
+
if (isPreconditionFailed(request.headers, etag, lastModifiedTime)) {
|
|
229
|
+
return { status: 412, headers };
|
|
230
|
+
}
|
|
231
|
+
if (isRequestFresh(request.headers, etag, lastModifiedTime)) {
|
|
232
|
+
return { status: 304, headers };
|
|
233
|
+
}
|
|
234
|
+
let status = 200;
|
|
235
|
+
let start = 0;
|
|
236
|
+
let end = size - 1;
|
|
237
|
+
const range = request.method === "GET" ? flattenStandardHeader(request.headers.range) : void 0;
|
|
238
|
+
if (range !== void 0 && isRangeApplicable(request.headers, etag, lastModifiedTime)) {
|
|
239
|
+
const parsed = parseByteRange(range, size);
|
|
240
|
+
if (parsed === "unsatisfiable") {
|
|
241
|
+
return { status: 416, headers: { ...headers, "content-range": `bytes */${size}` } };
|
|
242
|
+
}
|
|
243
|
+
if (parsed !== void 0) {
|
|
244
|
+
status = 206;
|
|
245
|
+
[start, end] = parsed;
|
|
246
|
+
headers["content-range"] = `bytes ${start}-${end}/${size}`;
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
if (contentEncoding !== void 0) {
|
|
250
|
+
headers["content-encoding"] = contentEncoding;
|
|
251
|
+
}
|
|
252
|
+
headers["content-type"] = contentType;
|
|
253
|
+
headers["content-length"] = `${end - start + 1}`;
|
|
254
|
+
const body = request.method === "HEAD" ? new ReadableStream({ start: (controller) => controller.close() }) : Readable.toWeb(status === 206 ? createReadStream(filePath, { start, end }) : createReadStream(filePath));
|
|
255
|
+
return { status, headers, body };
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
function stripTrailingSlash(path2) {
|
|
259
|
+
return path2.length > 1 && path2.endsWith("/") ? path2.slice(0, -1) : path2;
|
|
260
|
+
}
|
|
261
|
+
function stripWeakEtagPrefix(etag) {
|
|
262
|
+
return etag.startsWith("W/") ? etag.slice(2) : etag;
|
|
263
|
+
}
|
|
264
|
+
function isPreconditionFailed(requestHeaders, etag, lastModifiedTime) {
|
|
265
|
+
const ifMatch = flattenStandardHeader(requestHeaders["if-match"])?.trim();
|
|
266
|
+
if (ifMatch !== void 0 && ifMatch !== "") {
|
|
267
|
+
if (ifMatch === "*") {
|
|
268
|
+
return false;
|
|
269
|
+
}
|
|
270
|
+
return !ifMatch.split(",").some((tag) => tag.trim() === etag);
|
|
271
|
+
}
|
|
272
|
+
const ifUnmodifiedSince = flattenStandardHeader(requestHeaders["if-unmodified-since"]);
|
|
273
|
+
if (ifUnmodifiedSince !== void 0) {
|
|
274
|
+
const sinceTime = Date.parse(ifUnmodifiedSince);
|
|
275
|
+
return !Number.isNaN(sinceTime) && lastModifiedTime > sinceTime;
|
|
276
|
+
}
|
|
277
|
+
return false;
|
|
278
|
+
}
|
|
279
|
+
function isRequestFresh(requestHeaders, etag, lastModifiedTime) {
|
|
280
|
+
const ifNoneMatch = flattenStandardHeader(requestHeaders["if-none-match"]);
|
|
281
|
+
if (ifNoneMatch !== void 0) {
|
|
282
|
+
if (ifNoneMatch.trim() === "*") {
|
|
283
|
+
return true;
|
|
284
|
+
}
|
|
285
|
+
const bareEtag = stripWeakEtagPrefix(etag);
|
|
286
|
+
return ifNoneMatch.split(",").some((tag) => stripWeakEtagPrefix(tag.trim()) === bareEtag);
|
|
287
|
+
}
|
|
288
|
+
const ifModifiedSince = flattenStandardHeader(requestHeaders["if-modified-since"]);
|
|
289
|
+
if (ifModifiedSince !== void 0) {
|
|
290
|
+
const sinceTime = Date.parse(ifModifiedSince);
|
|
291
|
+
return !Number.isNaN(sinceTime) && lastModifiedTime <= sinceTime;
|
|
292
|
+
}
|
|
293
|
+
return false;
|
|
294
|
+
}
|
|
295
|
+
function isRangeApplicable(requestHeaders, etag, lastModifiedTime) {
|
|
296
|
+
const ifRange = flattenStandardHeader(requestHeaders["if-range"]);
|
|
297
|
+
if (ifRange === void 0) {
|
|
298
|
+
return true;
|
|
299
|
+
}
|
|
300
|
+
if (ifRange.startsWith('"') || ifRange.startsWith("W/")) {
|
|
301
|
+
return ifRange === etag;
|
|
302
|
+
}
|
|
303
|
+
return Date.parse(ifRange) === lastModifiedTime;
|
|
304
|
+
}
|
|
305
|
+
function parseByteRange(range, size) {
|
|
306
|
+
const match = range.match(/^bytes=\s*(\d*)-(\d*)$/i);
|
|
307
|
+
if (match === null || match[1] === "" && match[2] === "") {
|
|
308
|
+
return void 0;
|
|
309
|
+
}
|
|
310
|
+
if (match[1] === "") {
|
|
311
|
+
const suffixLength = Number(match[2]);
|
|
312
|
+
if (suffixLength === 0 || size === 0) {
|
|
313
|
+
return "unsatisfiable";
|
|
314
|
+
}
|
|
315
|
+
return [Math.max(0, size - suffixLength), size - 1];
|
|
316
|
+
}
|
|
317
|
+
const start = Number(match[1]);
|
|
318
|
+
if (start >= size) {
|
|
319
|
+
return "unsatisfiable";
|
|
320
|
+
}
|
|
321
|
+
const end = match[2] === "" ? size - 1 : Math.min(Number(match[2]), size - 1);
|
|
322
|
+
if (end < start) {
|
|
323
|
+
return void 0;
|
|
324
|
+
}
|
|
325
|
+
return [start, end];
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
export { StaticFileHandlerPlugin };
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@orpc/node",
|
|
3
|
+
"type": "module",
|
|
4
|
+
"version": "2.0.0-beta.25",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"funding": "https://github.com/sponsors/dinwwwh",
|
|
7
|
+
"homepage": "https://orpc.dev",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/middleapi/orpc.git",
|
|
11
|
+
"directory": "packages/node"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"orpc",
|
|
15
|
+
"node"
|
|
16
|
+
],
|
|
17
|
+
"sideEffects": false,
|
|
18
|
+
"exports": {
|
|
19
|
+
"./package.json": "./package.json",
|
|
20
|
+
".": {
|
|
21
|
+
"types": "./dist/index.d.mts",
|
|
22
|
+
"import": "./dist/index.mjs",
|
|
23
|
+
"default": "./dist/index.mjs"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@standardserver/core": "^0.7.1",
|
|
31
|
+
"mime": "^4.1.0",
|
|
32
|
+
"@orpc/shared": "2.0.0-beta.25",
|
|
33
|
+
"@orpc/server": "2.0.0-beta.25"
|
|
34
|
+
},
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"supertest": "^7.2.2"
|
|
37
|
+
},
|
|
38
|
+
"scripts": {
|
|
39
|
+
"build": "unbuild",
|
|
40
|
+
"type:check": "tsc -b"
|
|
41
|
+
}
|
|
42
|
+
}
|