mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 20:19:33 +01:00
Compare commits
404 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e15ea6b5a3 | ||
|
|
054fad952a | ||
|
|
e15a62a5b2 | ||
|
|
3f399f0c58 | ||
|
|
247a6448cb | ||
|
|
5301221148 | ||
|
|
7683499953 | ||
|
|
2c28424ecd | ||
|
|
18cd492ffd | ||
|
|
c2ae94b4a7 | ||
|
|
94eb3c6257 | ||
|
|
e55670169e | ||
|
|
4f7fbbe108 | ||
|
|
c32fdf7893 | ||
|
|
10bc1d3a4d | ||
|
|
7bd62822d3 | ||
|
|
967271089f | ||
|
|
169c6aa534 | ||
|
|
2d025788ce | ||
|
|
4af2b2ef3f | ||
|
|
ae0b7824f4 | ||
|
|
4339bf5059 | ||
|
|
252e2261e9 | ||
|
|
40eaf44f39 | ||
|
|
ad827bb716 | ||
|
|
08125cbf0c | ||
|
|
fb5723b071 | ||
|
|
8c35279cc2 | ||
|
|
61a5bcd2ee | ||
|
|
eaeab1565d | ||
|
|
e7453bfc70 | ||
|
|
54ef27d524 | ||
|
|
38d83dac34 | ||
|
|
0f7e52248f | ||
|
|
be55641338 | ||
|
|
6ba6e70b92 | ||
|
|
b710f809c7 | ||
|
|
4f647afa36 | ||
|
|
1defbe5954 | ||
|
|
fa6ba65d35 | ||
|
|
d4af221e89 | ||
|
|
6595a1d306 | ||
|
|
b506cd5f14 | ||
|
|
7a69573fb9 | ||
|
|
8e26e781d4 | ||
|
|
8efb63e70c | ||
|
|
4f6c07b0a1 | ||
|
|
aa3fe5527d | ||
|
|
6f17913eab | ||
|
|
d6c60cb2b3 | ||
|
|
76fbd59525 | ||
|
|
57faf8749a | ||
|
|
9456342d58 | ||
|
|
f89c8e44ef | ||
|
|
7f156806d8 | ||
|
|
bd33589d2f | ||
|
|
16b6ed315a | ||
|
|
6e74e44233 | ||
|
|
6485aa42a7 | ||
|
|
051d5bb325 | ||
|
|
b7d4dc7642 | ||
|
|
abb351268a | ||
|
|
c1a791558e | ||
|
|
14a18a783e | ||
|
|
209c28513d | ||
|
|
6157d51d59 | ||
|
|
0effea5efc | ||
|
|
f6f79ddab4 | ||
|
|
b4eea4393e | ||
|
|
ec576865c1 | ||
|
|
83aeeb7332 | ||
|
|
fd977982ec | ||
|
|
e5178d1634 | ||
|
|
6191a1f925 | ||
|
|
c100ee171c | ||
|
|
949e122be7 | ||
|
|
410dcf8a11 | ||
|
|
a8138602a2 | ||
|
|
bb2d1ef8dd | ||
|
|
7c8664d37d | ||
|
|
be20e63b79 | ||
|
|
5b1cdb6846 | ||
|
|
80573fb32e | ||
|
|
f01b8d5d8d | ||
|
|
09e0a6c479 | ||
|
|
a5cb0c754e | ||
|
|
ff88817168 | ||
|
|
f1ca99521e | ||
|
|
143092a16a | ||
|
|
27f7ed5fb4 | ||
|
|
cf38d0a13b | ||
|
|
c14a154723 | ||
|
|
0f00e561a1 | ||
|
|
0f3c0fff39 | ||
|
|
483b6e8076 | ||
|
|
491c04739a | ||
|
|
b1ddfc146b | ||
|
|
ee85f3ccd1 | ||
|
|
d8d4c92ae8 | ||
|
|
00da42d77e | ||
|
|
3db1100c87 | ||
|
|
fdde3f1db4 | ||
|
|
4ff57dfb97 | ||
|
|
aba32c7541 | ||
|
|
01c2bd5701 | ||
|
|
fe2e45be70 | ||
|
|
2c2df9e2bd | ||
|
|
5cf1acfa7e | ||
|
|
f67f7fc5f4 | ||
|
|
e11edc59eb | ||
|
|
e522a59a4c | ||
|
|
1d7be4642d | ||
|
|
3552017e4f | ||
|
|
de690a7914 | ||
|
|
d2666650de | ||
|
|
e3d35c6b04 | ||
|
|
b569afde50 | ||
|
|
d4f3942fff | ||
|
|
68003e9c3e | ||
|
|
b27938f108 | ||
|
|
9e443ac559 | ||
|
|
8ba002407a | ||
|
|
f061b0531f | ||
|
|
f08b724df7 | ||
|
|
4085d5fe26 | ||
|
|
13713343ce | ||
|
|
d6f11bb301 | ||
|
|
c5c1f1cdba | ||
|
|
0681dd554d | ||
|
|
e7a76694af | ||
|
|
da75c18ebe | ||
|
|
6289575900 | ||
|
|
ac212672e4 | ||
|
|
b8e2a83e26 | ||
|
|
fd98b0d414 | ||
|
|
20ab235856 | ||
|
|
7205c356f8 | ||
|
|
e14827e0c7 | ||
|
|
eea6406d5a | ||
|
|
2d3409a25b | ||
|
|
7a71a6e128 | ||
|
|
d8e89297cd | ||
|
|
6768205318 | ||
|
|
c20a092a31 | ||
|
|
64df8fb7ad | ||
|
|
d5567e5826 | ||
|
|
6b898e836c | ||
|
|
fd38c4f983 | ||
|
|
48d4c6342f | ||
|
|
297c3d52f4 | ||
|
|
0f9653d1a4 | ||
|
|
85998101c7 | ||
|
|
d6cb770154 | ||
|
|
c222008524 | ||
|
|
9cd21eb300 | ||
|
|
b4e83dbb0b | ||
|
|
0fa63c86ba | ||
|
|
7371dc4c10 | ||
|
|
77ab5f0dc6 | ||
|
|
ba15d15d67 | ||
|
|
7999039088 | ||
|
|
dc15500074 | ||
|
|
99a83562aa | ||
|
|
e04344d508 | ||
|
|
0f9d26ab60 | ||
|
|
e6b4386bd8 | ||
|
|
813b9ff7d7 | ||
|
|
5dce1f4681 | ||
|
|
470ba96be2 | ||
|
|
4532add2a7 | ||
|
|
876ed1d8d2 | ||
|
|
611e22d205 | ||
|
|
c1857f1079 | ||
|
|
796fa43a83 | ||
|
|
e3ce0bcaae | ||
|
|
e916f17d60 | ||
|
|
0fdb9e0e17 | ||
|
|
5bd5756d26 | ||
|
|
67f95756ab | ||
|
|
1fc4d9d0d0 | ||
|
|
c11a5cfa8a | ||
|
|
92c9f6390c | ||
|
|
3a6c5b659b | ||
|
|
750783e860 | ||
|
|
d9c8f877d3 | ||
|
|
e359702c41 | ||
|
|
e9081d00ad | ||
|
|
83f98e34fa | ||
|
|
512a0ae7b1 | ||
|
|
c89f8747ea | ||
|
|
3e8a2de6e5 | ||
|
|
5d98873cc3 | ||
|
|
a8e5538b05 | ||
|
|
24ecb41429 | ||
|
|
e8bf427d2b | ||
|
|
347d49482f | ||
|
|
2f7a1276ad | ||
|
|
f6db0c78cd | ||
|
|
d6012eb5c8 | ||
|
|
c1ab3ecf77 | ||
|
|
0e8f6cf9f6 | ||
|
|
0f5c09c7e0 | ||
|
|
5080e9a4a7 | ||
|
|
7490dbd090 | ||
|
|
1dc0ca7808 | ||
|
|
ffb692a168 | ||
|
|
d3203f0536 | ||
|
|
83e2b2810d | ||
|
|
2b4fff9faa | ||
|
|
752fe721a2 | ||
|
|
808cac4756 | ||
|
|
0c44f73c9f | ||
|
|
182875a781 | ||
|
|
0298f836b8 | ||
|
|
ea50430945 | ||
|
|
0e240663ca | ||
|
|
bb5e02383e | ||
|
|
c01dddea02 | ||
|
|
f92aec5b91 | ||
|
|
b6f92d954c | ||
|
|
9108dcbb1d | ||
|
|
07f415640f | ||
|
|
d5d211d2a8 | ||
|
|
3bfd3585b3 | ||
|
|
8ba8d79114 | ||
|
|
b7f72eac0a | ||
|
|
4c8a6d7b35 | ||
|
|
76619ac541 | ||
|
|
d5384cef02 | ||
|
|
fb3a0a834e | ||
|
|
b58d662edc | ||
|
|
5d560867bb | ||
|
|
ac7fbf3998 | ||
|
|
45fbab4c5f | ||
|
|
05ad1f96f6 | ||
|
|
41e6117113 | ||
|
|
81c7608fb0 | ||
|
|
a614bc588e | ||
|
|
3b0609e395 | ||
|
|
0819c21b94 | ||
|
|
deea70b743 | ||
|
|
0ee322c8a2 | ||
|
|
fc225ced0a | ||
|
|
b1d00c1f88 | ||
|
|
e0a6bb3576 | ||
|
|
fcd6cb1546 | ||
|
|
471ac30040 | ||
|
|
a7013db712 | ||
|
|
bdcff360f0 | ||
|
|
1490790edc | ||
|
|
4c5e6812b1 | ||
|
|
23d2954aae | ||
|
|
3c39746fa2 | ||
|
|
5fb7a9d444 | ||
|
|
a2275567e8 | ||
|
|
c040db4308 | ||
|
|
72755315a5 | ||
|
|
3d49810641 | ||
|
|
ebb6637238 | ||
|
|
0c83ade918 | ||
|
|
97d9b3ddf8 | ||
|
|
eaa61f3700 | ||
|
|
a5a9f430d5 | ||
|
|
94f59c396a | ||
|
|
fe4c10ae25 | ||
|
|
7a97127353 | ||
|
|
0c4a43ec19 | ||
|
|
da6d738406 | ||
|
|
70c0b35c48 | ||
|
|
da52b350ba | ||
|
|
b45c613ce7 | ||
|
|
025ce7e028 | ||
|
|
4e637a4ec3 | ||
|
|
2b5daf54fa | ||
|
|
217c3fd8e9 | ||
|
|
14617d864d | ||
|
|
3522cc9327 | ||
|
|
09500bc868 | ||
|
|
6ddfbf9629 | ||
|
|
97dfefe6cd | ||
|
|
b61dbd1786 | ||
|
|
4bb2cdc2d2 | ||
|
|
29909328c4 | ||
|
|
da44e5429f | ||
|
|
ae920a37fd | ||
|
|
bad2de134b | ||
|
|
14da8bbda6 | ||
|
|
e69dacf07a | ||
|
|
f8de361eaf | ||
|
|
0a5735125f | ||
|
|
a04ed72c45 | ||
|
|
d435c7c9c5 | ||
|
|
a3ce2c9a92 | ||
|
|
b0e7cc1854 | ||
|
|
9d07dab57d | ||
|
|
7257842438 | ||
|
|
b72b0449c1 | ||
|
|
d47fbc4537 | ||
|
|
c0b570ca09 | ||
|
|
95f5478cdc | ||
|
|
000ac03295 | ||
|
|
91421c1849 | ||
|
|
bdeada0e6e | ||
|
|
fd9b86fb18 | ||
|
|
5fab0e54b0 | ||
|
|
7d2f464699 | ||
|
|
fdb9c2b474 | ||
|
|
4ed504e1e9 | ||
|
|
92747711c6 | ||
|
|
3646e8cdfe | ||
|
|
88214185a8 | ||
|
|
ad03ae7b65 | ||
|
|
09e8ab536a | ||
|
|
f7dadd482d | ||
|
|
7b69cff1ed | ||
|
|
f2d7763fa4 | ||
|
|
20f5a08cbd | ||
|
|
75980c0953 | ||
|
|
a6f61d404f | ||
|
|
e53d1be61e | ||
|
|
d152ebc7be | ||
|
|
f6daa2b7c3 | ||
|
|
7962c7f61e | ||
|
|
453845fb14 | ||
|
|
ee3ee485ba | ||
|
|
cdf29bee67 | ||
|
|
d3d35404b1 | ||
|
|
e57c919157 | ||
|
|
d0fffbbc64 | ||
|
|
433d5ada46 | ||
|
|
5d180460af | ||
|
|
8991148d39 | ||
|
|
dd05285d65 | ||
|
|
d058ff241a | ||
|
|
fb4894e264 | ||
|
|
186faff140 | ||
|
|
b9cdb228b7 | ||
|
|
1e67434a8f | ||
|
|
019bb20e50 | ||
|
|
695ce4c56e | ||
|
|
38649b7023 | ||
|
|
5cfef32baa | ||
|
|
8497289c65 | ||
|
|
224c4b317b | ||
|
|
d5d6780ca8 | ||
|
|
252d0f6692 | ||
|
|
d022710591 | ||
|
|
a926968f13 | ||
|
|
a8eba5ab8d | ||
|
|
5871528d67 | ||
|
|
def9d0b19d | ||
|
|
34f50fc4d6 | ||
|
|
9fe1469eba | ||
|
|
e48d7cd42c | ||
|
|
2b517ad77b | ||
|
|
77ee994e13 | ||
|
|
67a8a2a3ed | ||
|
|
556b5c8e08 | ||
|
|
85154f12d7 | ||
|
|
26ce46e12b | ||
|
|
c2cfd9a214 | ||
|
|
f736545128 | ||
|
|
59a9eb5f95 | ||
|
|
48fc19076f | ||
|
|
6b83e5d4ea | ||
|
|
0358a258d7 | ||
|
|
8e7f33c9d2 | ||
|
|
b8f4af2df3 | ||
|
|
666751678c | ||
|
|
cab89aaa66 | ||
|
|
4c9850fafc | ||
|
|
07693009f8 | ||
|
|
dceade155c | ||
|
|
4012249f09 | ||
|
|
38eda2c4d6 | ||
|
|
9468af75f4 | ||
|
|
ea24a67a6d | ||
|
|
5e8d04741c | ||
|
|
1032e65a0d | ||
|
|
f261d3feeb | ||
|
|
b1ca09e986 | ||
|
|
b804429fc0 | ||
|
|
7df64296ff | ||
|
|
a53d823f5e | ||
|
|
feef3dde6b | ||
|
|
82ee2ce672 | ||
|
|
f62a13766a | ||
|
|
c7888e81ed | ||
|
|
c77eb68f5d | ||
|
|
333539569c | ||
|
|
e5c40f183b | ||
|
|
977a9e1465 | ||
|
|
2620379e02 | ||
|
|
e4f42d5322 | ||
|
|
ad28a9124e | ||
|
|
273bda980b | ||
|
|
9c8509f79c | ||
|
|
2ce29137ce | ||
|
|
e9c5307e23 | ||
|
|
bbdabf544c | ||
|
|
aed10ac5b8 | ||
|
|
4b2c714658 | ||
|
|
43e9fefdbd | ||
|
|
dabda23976 |
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1 @@
|
||||
github: wobsoriano
|
||||
22
.github/workflows/release.yml
vendored
Normal file
22
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16.x
|
||||
|
||||
- run: npx changelogithub
|
||||
env:
|
||||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -49,3 +49,5 @@ coverage
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
|
||||
.vercel
|
||||
|
||||
37
CHANGELOG.md
Normal file
37
CHANGELOG.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## v0.10.4
|
||||
|
||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.3...v0.10.4)
|
||||
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Add reactive inputs ([054fad9](https://github.com/wobsoriano/trpc-nuxt/commit/054fad9))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update local deps ([7683499](https://github.com/wobsoriano/trpc-nuxt/commit/7683499))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- Remove engines property ([e15a62a](https://github.com/wobsoriano/trpc-nuxt/commit/e15a62a))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||
|
||||
## v0.10.3
|
||||
|
||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.2...v0.10.3)
|
||||
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Export createH3ApiHandler for h3 apps ([18cd492](https://github.com/wobsoriano/trpc-nuxt/commit/18cd492))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||
|
||||
163
README.md
163
README.md
@@ -1,12 +1,16 @@
|
||||
# tRPC-Nuxt
|
||||
<p align="center">
|
||||
<figure>
|
||||
<img src="https://trpc-nuxt.vercel.app/cover.jpg" alt="trpc-nuxt cover image" />
|
||||
</figure>
|
||||
</p>
|
||||
|
||||
[](https://www.npmjs.com/package/trpc-nuxt)
|
||||
# tRPC-Nuxt
|
||||
|
||||
End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
||||
|
||||
<p align="center">
|
||||
<figure>
|
||||
<img src="https://i.imgur.com/AjmNUxj.gif" alt="Demo" />
|
||||
<img src="https://i.imgur.com/3AZlBZH.gif" alt="Demo" />
|
||||
<figcaption>
|
||||
<p align="center">
|
||||
The client above is <strong>not</strong> importing any code from the server, only its type declarations.
|
||||
@@ -15,156 +19,17 @@ End-to-end typesafe APIs with [tRPC.io](https://trpc.io/) in Nuxt applications.
|
||||
</figure>
|
||||
</p>
|
||||
|
||||
## Install
|
||||
Docs: https://trpc-nuxt.vercel.app
|
||||
|
||||
```bash
|
||||
npm i trpc-nuxt
|
||||
```
|
||||
|
||||
```ts
|
||||
// nuxt.config.ts
|
||||
import { defineNuxtConfig } from 'nuxt'
|
||||
|
||||
export default defineNuxtConfig({
|
||||
modules: ['trpc-nuxt'],
|
||||
trpc: {
|
||||
baseURL: 'http://localhost:3000', // defaults to http://localhost:3000
|
||||
trpcURL: '/api/trpc', // defaults to /api/trpc
|
||||
},
|
||||
typescript: {
|
||||
strict: true // set this to true to make input/output types work
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Expose your tRPC [routes](https://trpc.io/docs/router) under `~/server/trpc/index.ts`:
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import type { inferAsyncReturnType } from '@trpc/server'
|
||||
import * as trpc from '@trpc/server'
|
||||
import { z } from 'zod' // yup/superstruct/zod/myzod/custom
|
||||
|
||||
export const router = trpc.router()
|
||||
// queries and mutations...
|
||||
.query('getUsers', {
|
||||
async resolve(req) {
|
||||
// use your ORM of choice
|
||||
return await UserModel.all()
|
||||
},
|
||||
})
|
||||
.mutation('createUser', {
|
||||
// validate input with Zod
|
||||
input: z.object({ name: z.string().min(5) }),
|
||||
async resolve(req) {
|
||||
// use your ORM of choice
|
||||
return await UserModel.create({
|
||||
data: req.input,
|
||||
})
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
Use the client like so:
|
||||
|
||||
```ts
|
||||
const client = useClient() // auto-imported
|
||||
|
||||
const users = await client.query('getUsers')
|
||||
|
||||
const newUser = await client.mutation('createUser', {
|
||||
name: 'wagmi'
|
||||
})
|
||||
```
|
||||
|
||||
## useAsyncQuery
|
||||
|
||||
A thin wrapper around [`useAsyncData`](https://v3.nuxtjs.org/api/composables/use-async-data/) and `client.query()`.
|
||||
|
||||
The first argument is a `[path, input]`-tuple - if the `input` is optional, you can omit the, `input`-part.
|
||||
|
||||
You'll notice that you get autocompletion on the `path` and automatic typesafety on the `input`.
|
||||
|
||||
```ts
|
||||
const {
|
||||
data,
|
||||
pending,
|
||||
error,
|
||||
refresh
|
||||
} = await useAsyncQuery(['getUser', { id: 69 }], {
|
||||
// pass useAsyncData options here
|
||||
lazy: false
|
||||
})
|
||||
```
|
||||
|
||||
## useClientHeaders
|
||||
|
||||
A composable that lets you add additional properties to pass to the tRPC Client. It uses `useStorage` from [@vueuse/core](https://vueuse.org/core/usestorage).
|
||||
|
||||
```ts
|
||||
const headers = useClientHeaders()
|
||||
|
||||
const { data: token } = await useAsyncQuery(['auth.login', { username, password }])
|
||||
|
||||
headers.value.Authorization = `Bearer ${token}`
|
||||
|
||||
// All client calls will now include the Authorization header.
|
||||
// For SSR, please follow this until I found a solution https://github.com/trpc/trpc/discussions/1686
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
trpc-nuxt accepts the following options exposed under `~/server/trpc/index.ts`:
|
||||
|
||||
```ts
|
||||
import * as trpc from '@trpc/server'
|
||||
import type { inferAsyncReturnType } from '@trpc/server'
|
||||
import type { CompatibilityEvent } from 'h3'
|
||||
import type { OnErrorPayload } from 'trpc-nuxt/api'
|
||||
|
||||
export const router = trpc.router<inferAsyncReturnType<typeof createContext>>()
|
||||
|
||||
// Optional
|
||||
// https://trpc.io/docs/context
|
||||
export const createContext = (event: CompatibilityEvent) => {
|
||||
// ...
|
||||
return {
|
||||
/** context data */
|
||||
}
|
||||
}
|
||||
|
||||
// Optional
|
||||
// https://trpc.io/docs/caching#using-responsemeta--to-cache-responses
|
||||
export const responseMeta = () => {
|
||||
// ...
|
||||
return {
|
||||
// { headers: ... }
|
||||
}
|
||||
}
|
||||
|
||||
// Optional
|
||||
// https://trpc.io/docs/error-handling#handling-errors
|
||||
export const onError = (payload: OnErrorPayload<typeof router>) => {
|
||||
// Do whatever here like send to bug reporting and stuff
|
||||
}
|
||||
```
|
||||
|
||||
## Recipes
|
||||
|
||||
- [Validation](/recipes/validation.md)
|
||||
- [Authorization](/recipes/authorization.md)
|
||||
- [Merging Routers](/recipes/merging-routers.md)
|
||||
- [Error Handling](/recipes/error-handling.md)
|
||||
- [Error Formatting](/recipes/error-formatting.md)
|
||||
- [Inference Helpers](/recipes/inference-helpers.md)
|
||||
|
||||
Learn more about tRPC.io [here](https://trpc.io/docs).
|
||||
For version 3 of this module (tRPC v9, auto-imports, auto handlers), [go here](https://github.com/wobsoriano/trpc-nuxt/tree/v3).
|
||||
|
||||
## Recommended IDE Setup
|
||||
|
||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Huge thanks to [Alex / KATT](https://github.com/KATT), the author of [tRPC](https://trpc.io/), for being the first sponsor of this project! 🎉
|
||||
|
||||
## License
|
||||
|
||||
|
||||
1
client.d.ts
vendored
Normal file
1
client.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
||||
export * from './dist/client/index'
|
||||
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.vercel
|
||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@@ -0,0 +1 @@
|
||||
docs
|
||||
38
docs/app.config.ts
Normal file
38
docs/app.config.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
export default defineAppConfig({
|
||||
docus: {
|
||||
title: "tRPC Nuxt",
|
||||
description: "End-to-end typesafe APIs in Nuxt applications.",
|
||||
image: "https://og-image.vercel.app/tRPC-Nuxt",
|
||||
alt: "tRPC-Nuxt cover",
|
||||
url: "https://trpc-nuxt.vercel.app",
|
||||
debug: false,
|
||||
socials: {
|
||||
github: "wobsoriano/trpc-nuxt"
|
||||
},
|
||||
cover: {
|
||||
src: "/cover.jpg",
|
||||
alt: "tRPC-Nuxt module"
|
||||
},
|
||||
header: {
|
||||
logo: true
|
||||
},
|
||||
aside: {
|
||||
level: 1
|
||||
},
|
||||
footer: {
|
||||
credits: {
|
||||
icon: "IconDocus",
|
||||
text: "Powered by Docus",
|
||||
href: "https://docus.com"
|
||||
},
|
||||
iconLinks: [
|
||||
{
|
||||
label: "NuxtJS",
|
||||
href: "https://nuxt.com",
|
||||
// @ts-expect-error: IDK nuxt
|
||||
component: "IconNuxtLabs"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
})
|
||||
99
docs/components/Logo.vue
Normal file
99
docs/components/Logo.vue
Normal file
@@ -0,0 +1,99 @@
|
||||
<template>
|
||||
<div class="logo">
|
||||
<div v-if="$colorMode.value == 'dark'">
|
||||
<svg
|
||||
width="40"
|
||||
height="40"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
viewBox="0 0 509 454.27"
|
||||
>
|
||||
<path
|
||||
d="M363.3,307.79v.31l.28-.48Z"
|
||||
fill="#fff"
|
||||
stroke="#fff"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
|
||||
fill="#fff"
|
||||
stroke="#fff"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
|
||||
fill="#fff"
|
||||
stroke="#fff"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
|
||||
fill="#fff"
|
||||
stroke="#fff"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
|
||||
fill="#fff"
|
||||
stroke="#fff"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
|
||||
<div v-else>
|
||||
<svg
|
||||
width="40"
|
||||
height="40"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
viewBox="0 0 509 454.27"
|
||||
>
|
||||
<path
|
||||
d="M363.3,307.79v.31l.28-.48Z"
|
||||
stroke="#000"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M16.88,307.79v.3l.27-.46ZM83.1,350.1l.15.25.14-.08Z"
|
||||
stroke="#000"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M433.22,259.49V139.58l-102-58.85V49.53L254.48,5.2,251.38,7,177.69,49.53V80.79L75.85,139.58V259.44L4.5,300.64v88.68l76.79,44.33,73.27-42.3,100,57.73,100-57.71,73.23,42.28,76.79-44.33V300.64ZM254.48,19.5l57.89,33.41L254,86.37C238.27,77,212.74,61.79,197.24,52.54Zm64.41,43.94v67.62l-58.22,33.61V96.81Zm-128.82-.75c13.83,8.23,44,26.24,58.22,34.69v67.29l-58.22-33.61ZM16.88,307.79l.27-.16-.27.46Zm58.22,108L16.88,382.16V313.8L75.1,348.49Zm5.7-78.29c.71.41-55.37-33-56.76-33.82L81.29,270.6,139.18,304Zm2.45,12.87-.15-.25.29.17Zm62.45,31.81-3.52,2-54.7,31.57V347.92l58.22-33.37Zm205.22-81.52v78.49l-96.39,55.65-96.45-55.69V300.64L88.23,260.32V146.73l89.46-51.65V138.2l76.79,44.33,76.79-44.33V95l89.57,51.71V260.27Zm12.66,7-.28.48v-.31Zm57.94,108.15-54.65-31.55-3.57-2.06V313.79l58.22,34.7Zm5.7-78.29-56.76-33.82,57.25-33.06L485.59,304Zm64.9,44.68L433.9,415.77V347.92l58.22-33.37Z"
|
||||
stroke="#000"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M83.1,350.1l.15.25.14-.08Zm0,0,.15.25.14-.08Zm0,0,.15.25.14-.08Z"
|
||||
stroke="#000"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
<path
|
||||
d="M322.58,277.47l-34.44-57.86a9.2,9.2,0,0,0-3.4-3.3,9.47,9.47,0,0,0-12.67,3.3l-8.81,14.8L246,205.46c-3.46-6-12.61-6-16.07,0l-42.86,72a8.78,8.78,0,0,0,0,9,9.33,9.33,0,0,0,8,4.5h32.19c12.76,0,22.16-5.43,28.64-16,5.44-9.14,18.84-31.66,24.13-40.53l25.26,42.44H271.68L263.26,291h51.29C321.45,291.06,326.22,283.5,322.58,277.47Zm-79-10c-4.3,6.87-9.18,9.38-16.76,9.38H204.34L238,220.24l16.8,28.3Z"
|
||||
stroke="#000"
|
||||
stroke-miterlimit="10"
|
||||
stroke-width="9"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
|
||||
<ProseStrong>tRPC Nuxt</ProseStrong>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.logo {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
font-weight: 800;
|
||||
}
|
||||
</style>
|
||||
46
docs/content/1.get-started/1.installation.md
Normal file
46
docs/content/1.get-started/1.installation.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Installation
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
::code-group
|
||||
|
||||
```bash [pnpm]
|
||||
pnpm add @trpc/server @trpc/client trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [npm]
|
||||
npm install @trpc/server @trpc/client trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [yarn]
|
||||
yarn add @trpc/server @trpc/client trpc-nuxt zod
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
```ts [nuxt.config.ts]
|
||||
export default defineNuxtConfig({
|
||||
build: {
|
||||
transpile: ['trpc-nuxt']
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
#### Why @trpc/server?
|
||||
|
||||
For implementing tRPC endpoints and routers.
|
||||
|
||||
#### Why @trpc/client?
|
||||
|
||||
For making typesafe API calls from your client.
|
||||
|
||||
#### Why zod?
|
||||
|
||||
Most examples use [Zod](https://github.com/colinhacks/zod) for input validation and tRPC.io highly recommends it, though it isn't required.
|
||||
|
||||
## Next Steps
|
||||
|
||||
Now that you've installed the required dependencies, you are ready to start building your application.
|
||||
118
docs/content/1.get-started/2.usage/1.simple.md
Normal file
118
docs/content/1.get-started/2.usage/1.simple.md
Normal file
@@ -0,0 +1,118 @@
|
||||
---
|
||||
title: Simple
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Simple Usage
|
||||
|
||||
## 1. Create a tRPC router
|
||||
|
||||
Initialize your tRPC backend using the `initTRPC` function and create your first router.
|
||||
|
||||
::code-group
|
||||
|
||||
```ts [server/trpc/trpc.ts]
|
||||
/**
|
||||
* This is your entry point to setup the root configuration for tRPC on the server.
|
||||
* - `initTRPC` should only be used once per app.
|
||||
* - We export only the functionality that we use so we can enforce which base procedures should be used
|
||||
*
|
||||
* Learn how to create protected base procedures and other things below:
|
||||
* @see https://trpc.io/docs/v10/router
|
||||
* @see https://trpc.io/docs/v10/procedures
|
||||
*/
|
||||
import { initTRPC } from '@trpc/server'
|
||||
|
||||
const t = initTRPC.create()
|
||||
|
||||
/**
|
||||
* Unprotected procedure
|
||||
**/
|
||||
export const publicProcedure = t.procedure;
|
||||
|
||||
export const router = t.router;
|
||||
export const middleware = t.middleware;
|
||||
```
|
||||
|
||||
```ts [server/api/trpc/[trpc].ts]
|
||||
/**
|
||||
* This is the API-handler of your app that contains all your API routes.
|
||||
* On a bigger app, you will probably want to split this file up into multiple files.
|
||||
*/
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { publicProcedure, router } from '~/server/trpc/trpc'
|
||||
import { z } from 'zod'
|
||||
|
||||
export const appRouter = router({
|
||||
hello: publicProcedure
|
||||
// This is the input schema of your procedure
|
||||
.input(
|
||||
z.object({
|
||||
text: z.string().nullish(),
|
||||
}),
|
||||
)
|
||||
.query(({ input }) => {
|
||||
// This is what you're returning to your client
|
||||
return {
|
||||
greeting: `hello ${input?.text ?? 'world'}`,
|
||||
}
|
||||
}),
|
||||
})
|
||||
|
||||
// export only the type definition of the API
|
||||
// None of the actual implementation is exposed to the client
|
||||
export type AppRouter = typeof appRouter;
|
||||
|
||||
// export API handler
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
createContext: () => ({}),
|
||||
})
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
## 2. Create tRPC client plugin
|
||||
|
||||
Create a strongly-typed plugin using your API's type signature.
|
||||
|
||||
```ts [plugins/client.ts]
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/api/trpc/[trpc]'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
/**
|
||||
* createTRPCNuxtClient adds a `useQuery` composable
|
||||
* built on top of `useAsyncData`.
|
||||
*/
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## 3. Make an API request
|
||||
|
||||
```vue [pages/index.vue]
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const { data: hello } = await $client.hello.useQuery({ text: 'client' })
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div>
|
||||
<p>{{ hello?.greeting }}</p>
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
153
docs/content/1.get-started/2.usage/2.recommended.md
Normal file
153
docs/content/1.get-started/2.usage/2.recommended.md
Normal file
@@ -0,0 +1,153 @@
|
||||
---
|
||||
title: Recommended
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Recommended Usage
|
||||
|
||||
Recommended but not enforced file structure.
|
||||
|
||||
```graphql
|
||||
.
|
||||
├── server
|
||||
│ ├── api
|
||||
│ │ └── trpc
|
||||
│ │ └── [trpc].ts # <-- tRPC HTTP handler
|
||||
│ │ └── [..]
|
||||
│ ├── trpc
|
||||
│ │ ├── routers
|
||||
│ │ │ ├── index.ts # <-- main app router
|
||||
│ │ │ ├── todo.ts # <-- sub routers
|
||||
│ │ │ └── [..]
|
||||
│ │ ├── context.ts # <-- create app context
|
||||
│ │ └── trpc.ts # <-- procedure helpers
|
||||
├── plugins
|
||||
│ ├── client.ts # <-- tRPC client plugin
|
||||
└── [..]
|
||||
```
|
||||
|
||||
## 1. Create a tRPC router
|
||||
|
||||
Initialize your tRPC backend using the `initTRPC` function and create your first router.
|
||||
|
||||
::code-group
|
||||
|
||||
```ts [server/trpc/trpc.ts]
|
||||
/**
|
||||
* This is your entry point to setup the root configuration for tRPC on the server.
|
||||
* - `initTRPC` should only be used once per app.
|
||||
* - We export only the functionality that we use so we can enforce which base procedures should be used
|
||||
*
|
||||
* Learn how to create protected base procedures and other things below:
|
||||
* @see https://trpc.io/docs/v10/router
|
||||
* @see https://trpc.io/docs/v10/procedures
|
||||
*/
|
||||
import { initTRPC } from '@trpc/server'
|
||||
import { Context } from '~/server/trpc/context'
|
||||
|
||||
const t = initTRPC.context<Context>().create()
|
||||
|
||||
/**
|
||||
* Unprotected procedure
|
||||
**/
|
||||
export const publicProcedure = t.procedure;
|
||||
export const router = t.router;
|
||||
export const middleware = t.middleware;
|
||||
```
|
||||
|
||||
```ts [server/trpc/routers/index.ts]
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
export const appRouter = router({
|
||||
hello: publicProcedure
|
||||
.input(
|
||||
z.object({
|
||||
text: z.string().nullish(),
|
||||
}),
|
||||
)
|
||||
.query(({ input }) => {
|
||||
return {
|
||||
greeting: `hello ${input?.text ?? 'world'}`,
|
||||
}
|
||||
}),
|
||||
})
|
||||
|
||||
// export type definition of API
|
||||
export type AppRouter = typeof appRouter
|
||||
```
|
||||
|
||||
```ts [server/api/trpc/[trpc].ts]
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { appRouter } from '~/server/trpc/routers'
|
||||
import { createContext } from '~/server/trpc/context'
|
||||
|
||||
// export API handler
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
createContext,
|
||||
})
|
||||
```
|
||||
|
||||
```ts [server/trpc/context.ts]
|
||||
import { inferAsyncReturnType } from '@trpc/server'
|
||||
|
||||
/**
|
||||
* Creates context for an incoming request
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
export const createContext = () => ({})
|
||||
|
||||
export type Context = inferAsyncReturnType<typeof createContext>;
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
::alert{type=info}
|
||||
If you need to split your router into several subrouters, you can implement them in the `server/trpc/routers` directory and import and [merge them](https://trpc.io/docs/v10/merging-routers) to a single root `appRouter`.
|
||||
::
|
||||
|
||||
## 2. Create tRPC client plugin
|
||||
|
||||
Create a strongly-typed plugin using your API's type signature.
|
||||
|
||||
```ts [plugins/client.ts]
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
/**
|
||||
* createTRPCNuxtClient adds a `useQuery` composable
|
||||
* built on top of `useAsyncData`.
|
||||
*/
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
## 3. Make an API request
|
||||
|
||||
```vue [pages/index.vue]
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const hello = await $client.hello.useQuery({ text: 'client' })
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div>
|
||||
<p>{{ hello.data?.greeting }}</p>
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
53
docs/content/1.get-started/3.client.md
Normal file
53
docs/content/1.get-started/3.client.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Client
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Nuxt client
|
||||
|
||||
The magic of tRPC is making strongly typed API calls without relying on code generation. With full-stack TypeScript projects, you can directly import types from the server into the client! This is a vital part of how tRPC works.
|
||||
|
||||
## Initialize a tRPC client
|
||||
|
||||
Create a typesafe client via a Nuxt [plugin](https://nuxt.com/docs/guide/directory-structure/plugins) with the `createTRPCNuxtClient` method from `trpc-nuxt/client`, and add a `links` array with a [terminating link](https://trpc.io/docs/links#the-terminating-link). If you want to learn more about tRPC links, check out the docs [here](https://trpc.io/docs/links):
|
||||
|
||||
::alert{type="info"}
|
||||
`createTRPCNuxtClient` extends [createTRPCProxyClient](https://trpc.io/docs/vanilla#initialize-a-trpc-client) and adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data).
|
||||
::
|
||||
|
||||
```ts [plugins/client.ts]
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
As you can see, we passed `AppRouter` as a type argument of `createTRPCNuxtClient`. This returns a strongly typed `client` instance, a proxy that mirrors the structure of your `AppRouter` on the client:
|
||||
|
||||
```vue [pages/index.vue]
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const getUser = await $client.getUser.useQuery('id_bilbo');
|
||||
// => { data: { id: 'id_bilbo', name: 'Bilbo' }, pending: false, error: false };
|
||||
|
||||
const bilbo = await $client.getUser.query('id_bilbo');
|
||||
// => { id: 'id_bilbo', name: 'Bilbo' };
|
||||
const frodo = await $client.createUser.mutate({ name: 'Frodo' });
|
||||
// => { id: 'id_frodo', name: 'Frodo' };
|
||||
</script>
|
||||
```
|
||||
58
docs/content/1.get-started/4.links/1.httpLink.md
Normal file
58
docs/content/1.get-started/4.links/1.httpLink.md
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: HTTP Link
|
||||
description: httpLink is a terminating link that sends a tRPC operation to a tRPC procedure over HTTP.
|
||||
---
|
||||
|
||||
# HTTP Link
|
||||
|
||||
`httpLink` is a [terminating link](https://trpc.io/docs/links#the-terminating-link) that sends a tRPC operation to a tRPC procedure over HTTP.
|
||||
|
||||
`httpLink` supports both POST and GET requests.
|
||||
|
||||
::alert{type="info"}
|
||||
`httpLink` imported from `trpc-nuxt/client` is a convenience wrapper around the original `httpLink` that replaces regular `fetch` with a [`$fetch`](https://nuxt.com/docs/api/utils/dollarfetch) from Nuxt. It also sets the default headers using [`useRequestHeaders`](https://nuxt.com/docs/api/composables/use-request-headers#userequestheaders).
|
||||
::
|
||||
|
||||
## Usage
|
||||
|
||||
You can import and add the `httpLink` to the `links` array as such:
|
||||
|
||||
```ts
|
||||
import { createTRPCNuxtClient, httpLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpLink({
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
## `httpLink` Options
|
||||
|
||||
The `httpLink` function takes an options object that has the `HTTPLinkOptions` shape.
|
||||
|
||||
```ts
|
||||
export interface HTTPLinkOptions {
|
||||
url: string;
|
||||
/**
|
||||
* Select headers to pass to `useRequestHeaders`.
|
||||
*/
|
||||
pickHeaders?: string[];
|
||||
/**
|
||||
* Add ponyfill for fetch.
|
||||
*/
|
||||
fetch?: typeof fetch;
|
||||
/**
|
||||
* Add ponyfill for AbortController
|
||||
*/
|
||||
AbortController?: typeof AbortController | null;
|
||||
/**
|
||||
* Headers to be set on outgoing requests or a callback that of said headers
|
||||
* @link http://trpc.io/docs/v10/header
|
||||
*/
|
||||
headers?: HTTPHeaders | (() => HTTPHeaders | Promise<HTTPHeaders>);
|
||||
}
|
||||
```
|
||||
88
docs/content/1.get-started/4.links/2.httpBatchLink.md
Normal file
88
docs/content/1.get-started/4.links/2.httpBatchLink.md
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: HTTP Batch Link
|
||||
description: httpBatchLink is a terminating link that batches an array of individual tRPC operations into a single HTTP request that's sent to a single tRPC procedure.
|
||||
---
|
||||
|
||||
# HTTP Batch Link
|
||||
|
||||
`httpBatchLink` is a [terminating link](https://trpc.io/docs/links#the-terminating-link) that batches an array of individual tRPC operations into a single HTTP request that's sent to a single tRPC procedure.
|
||||
|
||||
::alert{type="info"}
|
||||
`httpBatchLink` imported from `trpc-nuxt/client` is a convenience wrapper around the original `httpBatchLink` that replaces regular `fetch` with a [`$fetch`](https://nuxt.com/docs/api/utils/dollarfetch) from Nuxt. It also sets the default headers using [`useRequestHeaders`](https://nuxt.com/docs/api/composables/use-request-headers#userequestheaders).
|
||||
::
|
||||
|
||||
## Usage
|
||||
|
||||
You can import and add the `httpBatchLink` to the `links` array as such:
|
||||
|
||||
```ts
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
After that, you can make use of batching by setting all your procedures in a `Promise.all`. The code below will produce exactly one HTTP request and on the server exactly `one` database query:
|
||||
|
||||
```ts
|
||||
const somePosts = await Promise.all([
|
||||
$client.post.byId.query(1);
|
||||
$client.post.byId.query(2);
|
||||
$client.post.byId.query(3);
|
||||
])
|
||||
```
|
||||
|
||||
## `httpBatchLink` Options
|
||||
|
||||
The `httpBatchLink` function takes an options object that has the `HTTPBatchLinkOptions` shape.
|
||||
|
||||
```ts
|
||||
export interface HttpBatchLinkOptions extends HTTPLinkOptions {
|
||||
maxURLLength?: number;
|
||||
}
|
||||
|
||||
export interface HTTPLinkOptions {
|
||||
url: string;
|
||||
/**
|
||||
* Select headers to pass to `useRequestHeaders`.
|
||||
*/
|
||||
pickHeaders?: string[];
|
||||
/**
|
||||
* Add ponyfill for fetch.
|
||||
*/
|
||||
fetch?: typeof fetch;
|
||||
/**
|
||||
* Add ponyfill for AbortController
|
||||
*/
|
||||
AbortController?: typeof AbortController | null;
|
||||
/**
|
||||
* Headers to be set on outgoing requests or a callback that of said headers
|
||||
* @link http://trpc.io/docs/v10/header
|
||||
*/
|
||||
headers?: HTTPHeaders | (() => HTTPHeaders | Promise<HTTPHeaders>);
|
||||
}
|
||||
```
|
||||
|
||||
## Setting a maximum URL length
|
||||
|
||||
When sending batch requests, sometimes the URL can become too large causing HTTP errors like [413 Payload Too Large](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413), [414 URI Too Long](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414), and [404 Not Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404). The `maxURLLength` option will limit the number of requests that can be sent together in a batch.
|
||||
|
||||
```ts
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client';
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
url: '/api/trpc',
|
||||
maxURLLength: 2083, // a suitable size
|
||||
}),
|
||||
],
|
||||
});
|
||||
```
|
||||
44
docs/content/1.get-started/5.tips/1.composables.md
Normal file
44
docs/content/1.get-started/5.tips/1.composables.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Composables
|
||||
---
|
||||
|
||||
# Composables
|
||||
|
||||
It is often useful to wrap functionality of your `@trpc/client` api within other functions. For this purpose, it's necessary to be able to infer input types and output types generated by your `@trpc/server` router.
|
||||
|
||||
::alert{type="info"}
|
||||
[createTRPCNuxtClient](/get-started/client/create) already adds a `useQuery` method built on top of [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data/). You might not need this.
|
||||
::
|
||||
|
||||
## Inference Helpers
|
||||
|
||||
`@trpc/server` exports the following helper types to assist with inferring these types from the `AppRouter` exported by your `@trpc/server` router:
|
||||
|
||||
- `inferRouterInputs<TRouter>`
|
||||
- `inferRouterOutputs<TRouter>`
|
||||
|
||||
Let's assume we have this example query wrapped within Nuxt's [useAsyncData](https://v3.nuxtjs.org/api/composables/use-async-data/):
|
||||
|
||||
```ts
|
||||
const { data, error } = await useAsyncData(() => $client.todo.getTodos.query())
|
||||
```
|
||||
|
||||
We can wrap this in a composable and also set the client error types:
|
||||
|
||||
```ts [composables/useGetTodos.ts]
|
||||
import { TRPCClientError } from '@trpc/client'
|
||||
import type { inferRouterOutputs } from '@trpc/server'
|
||||
import type { AppRouter } from '@/server/trpc/routers'
|
||||
|
||||
type RouterOutput = inferRouterOutputs<AppRouter>
|
||||
type GetTodosOutput = RouterOutput['todo']['getTodos']
|
||||
|
||||
type ErrorOutput = TRPCClientError<AppRouter>
|
||||
|
||||
export default function useGetTodos() {
|
||||
const { $client } = useNuxtApp()
|
||||
return useAsyncData<GetTodosOutput, ErrorOutput>(() => $client.todo.getTodos.query())
|
||||
}
|
||||
```
|
||||
|
||||
Now, we have a fully-typed composable.
|
||||
44
docs/content/1.get-started/5.tips/2.headers.md
Normal file
44
docs/content/1.get-started/5.tips/2.headers.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Headers
|
||||
---
|
||||
|
||||
# Headers
|
||||
|
||||
We can use the built-in [useRequestHeaders](https://v3.nuxtjs.org/api/composables/use-request-headers/) to set outgoing request headers:
|
||||
|
||||
::alert{type="info"}
|
||||
[createTRPCNuxtClient](/get-started/client/create) has this feature by default.
|
||||
::
|
||||
|
||||
```ts [plugins/client.ts]
|
||||
export default defineNuxtPlugin(() => {
|
||||
const headers = useRequestHeaders()
|
||||
|
||||
const client = createTRPCProxyClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
// headers need to be a function so it gets called dynamically
|
||||
// every HTTP request
|
||||
headers() {
|
||||
// You can add more custom headers here
|
||||
return headers
|
||||
}
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client,
|
||||
},
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
```ts [server/trpc/context.ts]
|
||||
export function createContext (event: H3Event) {
|
||||
console.log('cookies', parseCookies(event))
|
||||
|
||||
return {}
|
||||
}
|
||||
```
|
||||
103
docs/content/1.get-started/5.tips/3.authorization.md
Normal file
103
docs/content/1.get-started/5.tips/3.authorization.md
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: Authorization
|
||||
---
|
||||
|
||||
# Authorization
|
||||
|
||||
The `createContext` function is called for each incoming request so here you can add contextual information about the calling user from the request object.
|
||||
|
||||
::alert{type="warning"}
|
||||
Before you can access request headers in any context or middleware, you need to set the outgoing request headers. See [here](/get-started/tips/headers).
|
||||
::
|
||||
|
||||
## Create context from request headers
|
||||
|
||||
```ts [server/trpc/context.ts]
|
||||
import { inferAsyncReturnType } from '@trpc/server'
|
||||
import { decodeAndVerifyJwtToken } from './somewhere/in/your/app/utils'
|
||||
|
||||
export async function createContext(event: H3Event) {
|
||||
// Create your context based on the request object
|
||||
// Will be available as `ctx` in all your resolvers
|
||||
|
||||
// This is just an example of something you might want to do in your ctx fn
|
||||
const authorization = getRequestHeader(event, 'authorization')
|
||||
async function getUserFromHeader() {
|
||||
if (authorization) {
|
||||
const user = await decodeAndVerifyJwtToken(authorization.split(' ')[1])
|
||||
return user
|
||||
}
|
||||
return null
|
||||
}
|
||||
const user = await getUserFromHeader()
|
||||
|
||||
return {
|
||||
user,
|
||||
}
|
||||
}
|
||||
type Context = inferAsyncReturnType<typeof createContext>
|
||||
```
|
||||
|
||||
## Option 1: Authorize using resolver
|
||||
|
||||
```ts
|
||||
import { TRPCError, initTRPC } from '@trpc/server'
|
||||
import type { Context } from '../context'
|
||||
|
||||
export const t = initTRPC.context<Context>().create()
|
||||
|
||||
const appRouter = t.router({
|
||||
// open for anyone
|
||||
hello: t.procedure
|
||||
.input(z.string().nullish())
|
||||
.query(({ input, ctx }) => `hello ${input ?? ctx.user?.name ?? 'world'}`),
|
||||
// checked in resolver
|
||||
secret: t.procedure.query(({ ctx }) => {
|
||||
if (!ctx.user) {
|
||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||
}
|
||||
return {
|
||||
secret: 'sauce',
|
||||
}
|
||||
}),
|
||||
})
|
||||
```
|
||||
|
||||
## Option 2: Authorize using middleware
|
||||
|
||||
```ts
|
||||
import { TRPCError, initTRPC } from '@trpc/server'
|
||||
|
||||
export const t = initTRPC.context<Context>().create()
|
||||
|
||||
const isAuthed = t.middleware(({ next, ctx }) => {
|
||||
if (!ctx.user?.isAdmin) {
|
||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||
}
|
||||
return next({
|
||||
ctx: {
|
||||
user: ctx.user,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
// you can reuse this for any procedure
|
||||
export const protectedProcedure = t.procedure.use(isAuthed)
|
||||
|
||||
t.router({
|
||||
// this is accessible for everyone
|
||||
hello: t.procedure
|
||||
.input(z.string().nullish())
|
||||
.query(({ input, ctx }) => `hello ${input ?? ctx.user?.name ?? 'world'}`),
|
||||
admin: t.router({
|
||||
// this is accessible only to admins
|
||||
secret: protectedProcedure.query(({ ctx }) => {
|
||||
return {
|
||||
secret: 'sauce',
|
||||
}
|
||||
}),
|
||||
}),
|
||||
})
|
||||
```
|
||||
|
||||
This page is entirely based on [authorization docs](https://trpc.io/docs/v10/authorization) of tRPC with a minimal change made to work with Nuxt.
|
||||
84
docs/content/1.get-started/5.tips/4.server-side-calls.md
Normal file
84
docs/content/1.get-started/5.tips/4.server-side-calls.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Server Side Calls
|
||||
---
|
||||
|
||||
# Server Side Calls
|
||||
|
||||
You may need to call your procedure(s) directly from the server, `createCaller()` function returns you an instance of `RouterCaller` able to execute queries and mutations.
|
||||
|
||||
## Input query example
|
||||
|
||||
We create the router with a input query and then we call the asynchronous `greeting` procedure to get the result.
|
||||
|
||||
::code-group
|
||||
|
||||
```ts [server/trpc/trpc.ts]
|
||||
import { initTRPC } from '@trpc/server'
|
||||
import { z } from 'zod'
|
||||
|
||||
const t = initTRPC.create()
|
||||
|
||||
export const router = t.router({
|
||||
// Create procedure at path 'greeting'
|
||||
greeting: t.procedure
|
||||
.input(z.object({ name: z.string() }))
|
||||
.query(({ input }) => `Hello ${input.name}`),
|
||||
})
|
||||
```
|
||||
|
||||
```ts [server/api/greeting.ts]
|
||||
import { router } from '@/server/trpc/trpc'
|
||||
|
||||
export default eventHandler(async (event) => {
|
||||
const { name } = getQuery(event)
|
||||
const caller = router.createCaller({})
|
||||
|
||||
const greeting = await caller.greeting({ name })
|
||||
|
||||
return {
|
||||
greeting
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
## Mutation example
|
||||
|
||||
We create the router with a mutation and then we call the asynchronous `post` procedure to get the result.
|
||||
|
||||
::code-group
|
||||
|
||||
```ts [server/trpc/trpc.ts]
|
||||
import { initTRPC } from '@trpc/server'
|
||||
import { z } from 'zod'
|
||||
|
||||
const posts = ['One', 'Two', 'Three']
|
||||
|
||||
const t = initTRPC.create()
|
||||
export const router = t.router({
|
||||
post: t.router({
|
||||
add: t.procedure.input(z.string()).mutation(({ input }) => {
|
||||
posts.push(input)
|
||||
return posts
|
||||
}),
|
||||
}),
|
||||
})
|
||||
```
|
||||
|
||||
```ts [server/api/post.ts]
|
||||
import { router } from '@/server/trpc/trpc'
|
||||
|
||||
export default eventHandler(async (event) => {
|
||||
const body = await getBody(event)
|
||||
const caller = router.createCaller({})
|
||||
|
||||
const post = await caller.post.add(body.post)
|
||||
|
||||
return {
|
||||
post
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
::
|
||||
24
docs/content/1.get-started/5.tips/5.aborting-procedures.md
Normal file
24
docs/content/1.get-started/5.tips/5.aborting-procedures.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Aborting Procedures
|
||||
---
|
||||
|
||||
# Aborting Procedures
|
||||
|
||||
tRPC adheres to the industry standard when it comes to aborting procedures. All you have to do is pass an `AbortSignal` to the query-options and then call its parent `AbortController`'s `abort` method.
|
||||
|
||||
```ts [composables/useGetTodo.ts]
|
||||
export default function useGetTodo(id: number) {
|
||||
const { $client } = useNuxtApp()
|
||||
const ac = new AbortController()
|
||||
|
||||
onScopeDispose(() => {
|
||||
ac.abort()
|
||||
})
|
||||
|
||||
return useAsyncData(() => {
|
||||
return $client.todo.getTodo.query(id, {
|
||||
signal: ac.signal
|
||||
})
|
||||
})
|
||||
}
|
||||
```
|
||||
4
docs/content/1.get-started/index.md
Normal file
4
docs/content/1.get-started/index.md
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
navigation: false
|
||||
redirect: /get-started/installation
|
||||
---
|
||||
6
docs/content/2.examples/1.basic.md
Normal file
6
docs/content/2.examples/1.basic.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Basic
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Basic Example
|
||||
6
docs/content/2.examples/2.multiple-routers.md
Normal file
6
docs/content/2.examples/2.multiple-routers.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Multiple Routers
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Multi Routers
|
||||
32
docs/content/index.md
Normal file
32
docs/content/index.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: "tRPC Nuxt"
|
||||
description: "End-to-end typesafe APIs in Nuxt applications."
|
||||
navigation: false
|
||||
layout: page
|
||||
---
|
||||
|
||||
::block-hero
|
||||
---
|
||||
cta:
|
||||
- Get Started
|
||||
- /get-started/installation
|
||||
secondary:
|
||||
- Star on GitHub ->
|
||||
- https://github.com/wobsoriano/trpc-nuxt
|
||||
snippet: npm install trpc-nuxt
|
||||
---
|
||||
|
||||
#title
|
||||
tRPC [Nuxt]{.text-primary-500}
|
||||
|
||||
#description
|
||||
End-to-end typesafe APIs in Nuxt applications.
|
||||
|
||||
#extra
|
||||
::list
|
||||
- Automatic typesafety
|
||||
- Snappy DX
|
||||
- Autocompletion on the client, for inputs, outputs and errors
|
||||
- Leverages [useAsyncData](https://nuxt.com/docs/api/composables/use-async-data) and [$fetch](https://nuxt.com/docs/api/utils/dollarfetch)
|
||||
::
|
||||
::
|
||||
22
docs/nuxt.config.ts
Normal file
22
docs/nuxt.config.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
export default defineNuxtConfig({
|
||||
app: {
|
||||
pageTransition: false,
|
||||
layoutTransition: false
|
||||
},
|
||||
modules: ['@nuxtlabs/github-module'],
|
||||
extends: process.env.DOCUS_THEME_PATH || '@nuxt-themes/docus',
|
||||
github: {
|
||||
owner: 'wobsoriano',
|
||||
repo: 'trpc-nuxt',
|
||||
branch: 'next'
|
||||
},
|
||||
colorMode: {
|
||||
preference: 'dark'
|
||||
},
|
||||
build: {
|
||||
transpile: [/content-edge/, /github-module/]
|
||||
},
|
||||
nitro: {
|
||||
preset: 'vercel'
|
||||
}
|
||||
})
|
||||
15
docs/package.json
Normal file
15
docs/package.json
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "docs",
|
||||
"description": "Docs for TRPC-Nuxt",
|
||||
"scripts": {
|
||||
"dev": "nuxi dev",
|
||||
"build": "nuxi build",
|
||||
"generate": "nuxi build",
|
||||
"preview": "nuxi preview"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt-themes/docus": "^1.12.0",
|
||||
"@nuxtlabs/github-module": "^1.6.3",
|
||||
"nuxt": "3.4.3"
|
||||
}
|
||||
}
|
||||
BIN
docs/public/cover.jpg
Normal file
BIN
docs/public/cover.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/public/favicon.ico
Normal file
BIN
docs/public/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
18
docs/tokens.config.ts
Normal file
18
docs/tokens.config.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
import { defineTheme } from 'pinceau'
|
||||
|
||||
export default defineTheme({
|
||||
colors: {
|
||||
primary: {
|
||||
50: '#BFEDFC',
|
||||
100: '#B0E9FB',
|
||||
200: '#93DEFA',
|
||||
300: '#76D4F9',
|
||||
400: '#58C8F7',
|
||||
500: '#3BBBF6',
|
||||
600: '#0BA6F3',
|
||||
700: '#0981C2',
|
||||
800: '#075E91',
|
||||
900: '#043D61'
|
||||
}
|
||||
}
|
||||
})
|
||||
3
docs/tsconfig.json
Normal file
3
docs/tsconfig.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "./.nuxt/tsconfig.json"
|
||||
}
|
||||
98
package.json
98
package.json
@@ -1,61 +1,81 @@
|
||||
{
|
||||
"name": "trpc-nuxt",
|
||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||
"type": "module",
|
||||
"version": "0.1.19",
|
||||
"packageManager": "pnpm@7.1.1",
|
||||
"packageManager": "pnpm@8.5.1",
|
||||
"version": "0.10.4",
|
||||
"license": "MIT",
|
||||
"main": "./dist/module.cjs",
|
||||
"types": "./dist/types.d.ts",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
"./package.json": "./package.json",
|
||||
".": {
|
||||
"import": "./dist/module.mjs",
|
||||
"require": "./dist/module.cjs"
|
||||
"require": "./dist/index.cjs",
|
||||
"import": "./dist/index.mjs"
|
||||
},
|
||||
"./api": {
|
||||
"import": "./dist/runtime/api.mjs",
|
||||
"types": "./dist/runtime/api.d.ts"
|
||||
"./client": {
|
||||
"types": "./dist/client/index.d.ts",
|
||||
"require": "./dist/client/index.cjs",
|
||||
"import": "./dist/client/index.mjs"
|
||||
}
|
||||
},
|
||||
"main": "./dist/index.mjs",
|
||||
"module": "./dist/index.mjs",
|
||||
"types": "./dist/index.d.ts",
|
||||
"files": [
|
||||
"dist",
|
||||
"*.d.ts"
|
||||
"client.d.ts"
|
||||
],
|
||||
"scripts": {
|
||||
"prepublishOnly": "nr build",
|
||||
"build": "nuxt-module-build",
|
||||
"play": "nr build && nuxi dev playground",
|
||||
"build:playground": "nuxi build playground",
|
||||
"dev": "tsup --watch --onSuccess \"pnpm --filter playground dev\"",
|
||||
"dev:prepare": "pnpm build && nuxt prepare playground",
|
||||
"prepublishOnly": "pnpm build",
|
||||
"build": "tsup",
|
||||
"lint": "eslint .",
|
||||
"lint:fix": "eslint . --fix",
|
||||
"release": "bumpp --commit --push --tag && pnpm publish",
|
||||
"prepare": "nuxi prepare playground"
|
||||
"release": "changelogen --release && npm publish && git push --follow-tags",
|
||||
"update-deps": "taze -w && pnpm i"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@trpc/client": "^10.26.0",
|
||||
"@trpc/server": "^10.26.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@nuxt/kit": "^3.0.0-rc.3",
|
||||
"@trpc/client": "^9.23.3",
|
||||
"@trpc/server": "^9.23.2",
|
||||
"@vueuse/core": "^8.5.0",
|
||||
"@vueuse/nuxt": "^8.5.0",
|
||||
"defu": "^6.0.0",
|
||||
"h3": "^0.7.8",
|
||||
"pathe": "^0.3.0",
|
||||
"ufo": "^0.8.4"
|
||||
"h3": "^1.6.6",
|
||||
"ofetch": "^1.0.1",
|
||||
"ohash": "^1.1.2",
|
||||
"ufo": "^1.1.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@antfu/eslint-config": "^0.23.1",
|
||||
"@antfu/ni": "^0.16.2",
|
||||
"@nuxt/module-builder": "latest",
|
||||
"bumpp": "^7.1.1",
|
||||
"eslint": "^8.14.0",
|
||||
"nuxt": "^3.0.0-rc.3",
|
||||
"ohash": "^0.1.0",
|
||||
"pnpm": "^7.1.1",
|
||||
"superjson": "^1.9.1",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.16.0"
|
||||
"@nuxt/eslint-config": "^0.1.1",
|
||||
"@trpc/client": "^10.28.0",
|
||||
"@trpc/server": "^10.28.0",
|
||||
"changelogen": "^0.5.3",
|
||||
"eslint": "^8.41.0",
|
||||
"taze": "^0.10.1",
|
||||
"tsup": "6.7.0",
|
||||
"typescript": "^5.0.4"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": "@antfu"
|
||||
"extends": [
|
||||
"@nuxt/eslint-config"
|
||||
],
|
||||
"rules": {
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
"off"
|
||||
],
|
||||
"vue/multi-word-component-names": "off",
|
||||
"vue/no-multiple-template-root": "off"
|
||||
}
|
||||
},
|
||||
"eslintIgnore": [
|
||||
"*.json",
|
||||
"node_modules",
|
||||
"*.md",
|
||||
"dist",
|
||||
".output"
|
||||
],
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"nuxt": "3.4.3"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,13 +1,6 @@
|
||||
import { defineNuxtConfig } from 'nuxt'
|
||||
import Module from '../src/module'
|
||||
|
||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||
export default defineNuxtConfig({
|
||||
modules: [Module],
|
||||
runtimeConfig: {
|
||||
baseURL: 'http://localhost:3000',
|
||||
},
|
||||
typescript: {
|
||||
strict: true,
|
||||
},
|
||||
build: {
|
||||
transpile: ['trpc-nuxt']
|
||||
}
|
||||
})
|
||||
|
||||
@@ -1,4 +1,22 @@
|
||||
{
|
||||
"name": "playground",
|
||||
"private": true
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "nuxt build",
|
||||
"dev": "nuxt dev",
|
||||
"generate": "nuxt generate",
|
||||
"preview": "nuxt preview",
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"dependencies": {
|
||||
"@trpc/client": "^10.28.0",
|
||||
"@trpc/server": "^10.28.0",
|
||||
"superjson": "^1.12.3",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.21.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^18.16.15",
|
||||
"nuxt": "3.4.3"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
<script setup lang="ts">
|
||||
const counter = useCookie('counter')
|
||||
counter.value = counter.value || Math.round(Math.random() * 1000)
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div>
|
||||
<h1> Counter: {{ counter || '-' }}</h1>
|
||||
<button @click="counter = null">
|
||||
reset
|
||||
</button>
|
||||
<button @click="counter--">
|
||||
-
|
||||
</button>
|
||||
<button @click="counter++">
|
||||
+
|
||||
</button>
|
||||
</div>
|
||||
</template>
|
||||
@@ -1,55 +1,54 @@
|
||||
<script setup lang="ts">
|
||||
const client = useClient()
|
||||
const headers = useClientHeaders()
|
||||
const { data: todos, pending, error, refresh } = await useAsyncQuery(['getTodos'])
|
||||
|
||||
const addHeader = () => {
|
||||
// headers.value.cookie = 'counter=69'
|
||||
console.log(headers.value)
|
||||
}
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const addTodo = async () => {
|
||||
const title = Math.random().toString(36).slice(2, 7)
|
||||
|
||||
try {
|
||||
const result = await client.mutation('addTodo', {
|
||||
const x = await $client.todo.addTodo.mutate({
|
||||
id: Date.now(),
|
||||
userId: 69,
|
||||
title,
|
||||
completed: false,
|
||||
completed: false
|
||||
})
|
||||
console.log('Todo: ', result)
|
||||
}
|
||||
catch (e) {
|
||||
console.log(x)
|
||||
} catch (e) {
|
||||
console.log(e)
|
||||
}
|
||||
}
|
||||
|
||||
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useQuery()
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div v-if="pending">
|
||||
Loading...
|
||||
</div>
|
||||
<div v-else-if="error?.data?.code">
|
||||
Error: {{ error.data.code }}
|
||||
</div>
|
||||
<div v-else-if="todos">
|
||||
<ul>
|
||||
<li v-for="t in todos.slice(0, 10)" :key="t.id">
|
||||
<NuxtLink :class="{ completed: t.completed }" :to="`/todo/${t.id}`">
|
||||
Title: {{ t.title }}
|
||||
</NuxtLink>
|
||||
</li>
|
||||
</ul>
|
||||
<button @click="addTodo">
|
||||
Add Todo
|
||||
</button>
|
||||
<button @click="() => refresh()">
|
||||
Refresh
|
||||
</button>
|
||||
<button @click="addHeader">
|
||||
Add header
|
||||
</button>
|
||||
<div>
|
||||
<div v-if="pending">
|
||||
Loading...
|
||||
</div>
|
||||
<div v-else-if="error?.data?.code">
|
||||
Error: {{ error.data.code }}
|
||||
</div>
|
||||
<div v-else>
|
||||
<ul>
|
||||
<li
|
||||
v-for="t in todos?.slice(0, 10)"
|
||||
:key="t.id"
|
||||
>
|
||||
<NuxtLink
|
||||
:class="{ completed: t.completed }"
|
||||
:to="`/todo/${t.id}`"
|
||||
>
|
||||
Title: {{ t.title }}
|
||||
</NuxtLink>
|
||||
</li>
|
||||
</ul>
|
||||
<button @click="addTodo">
|
||||
Add Todo
|
||||
</button>
|
||||
<button @click="() => refresh()">
|
||||
Refresh
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
|
||||
29
playground/pages/reactive.vue
Normal file
29
playground/pages/reactive.vue
Normal file
@@ -0,0 +1,29 @@
|
||||
<script setup lang="ts">
|
||||
const route = useRoute()
|
||||
const { $client } = useNuxtApp()
|
||||
const id = ref(1)
|
||||
// const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(id.value), {
|
||||
// watch: [id]
|
||||
// })
|
||||
|
||||
const { data: todo, pending, error, refresh } = await $client.todo.getTodo.useQuery(id, {
|
||||
watch: [id],
|
||||
})
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div v-if="pending">
|
||||
Loading...
|
||||
</div>
|
||||
<div v-else-if="error?.data?.code">
|
||||
Error: {{ error.data.code }}
|
||||
</div>
|
||||
<div v-else>
|
||||
ID: {{ todo?.id }} <br>
|
||||
Title: {{ todo?.title }} <br>
|
||||
Completed: {{ todo?.completed }}
|
||||
</div>
|
||||
<button @click="id++">
|
||||
Next Todo
|
||||
</button>
|
||||
</template>
|
||||
@@ -1,18 +1,19 @@
|
||||
<script setup lang="ts">
|
||||
const route = useRoute()
|
||||
const { data: todo, pending, error } = await useAsyncQuery(['getTodo', Number(route.params.id)])
|
||||
const { $client } = useNuxtApp()
|
||||
const { data: todo, pending, error } = await useAsyncData(() => $client.todo.getTodo.query(Number(route.params.id)))
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div v-if="pending">
|
||||
Loading...
|
||||
</div>
|
||||
<div v-else-if="error?.data?.code">
|
||||
{{ error.data.code }}
|
||||
<div v-else-if="error">
|
||||
{{ error.message }} - {{ error.cause }}
|
||||
</div>
|
||||
<div v-else>
|
||||
ID: {{ todo.id }} <br>
|
||||
Title: {{ todo.title }} <br>
|
||||
Completed: {{ todo.completed }}
|
||||
ID: {{ todo?.id }} <br>
|
||||
Title: {{ todo?.title }} <br>
|
||||
Completed: {{ todo?.completed }}
|
||||
</div>
|
||||
</template>
|
||||
|
||||
25
playground/plugins/trpc-client.ts
Normal file
25
playground/plugins/trpc-client.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import { loggerLink } from '@trpc/client'
|
||||
import superjson from 'superjson'
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
transformer: superjson,
|
||||
links: [
|
||||
// adds pretty logs to your console in development and logs errors in production
|
||||
loggerLink({
|
||||
enabled: opts =>
|
||||
process.env.NODE_ENV === 'development' ||
|
||||
(opts.direction === 'down' && opts.result instanceof Error)
|
||||
}),
|
||||
httpBatchLink()
|
||||
]
|
||||
})
|
||||
|
||||
return {
|
||||
provide: {
|
||||
client
|
||||
}
|
||||
}
|
||||
})
|
||||
23
playground/server/api/trpc/[trpc].ts
Normal file
23
playground/server/api/trpc/[trpc].ts
Normal file
@@ -0,0 +1,23 @@
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { appRouter } from '@/server/trpc/routers'
|
||||
import { createContext } from '@/server/trpc/context'
|
||||
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
/**
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
createContext,
|
||||
onError ({ error }) {
|
||||
if (error.code === 'INTERNAL_SERVER_ERROR') {
|
||||
// send to bug reporting
|
||||
console.error('Something went wrong', error)
|
||||
}
|
||||
}
|
||||
/**
|
||||
* @link https://trpc.io/docs/caching#api-response-caching
|
||||
*/
|
||||
// responseMeta() {
|
||||
// // ...
|
||||
// },
|
||||
})
|
||||
18
playground/server/trpc/context.ts
Normal file
18
playground/server/trpc/context.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
import type { inferAsyncReturnType } from '@trpc/server'
|
||||
import type { H3Event } from 'h3'
|
||||
|
||||
export type Context = inferAsyncReturnType<typeof createContext>
|
||||
|
||||
/**
|
||||
* Creates context for an incoming request
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
export function createContext (
|
||||
event: H3Event
|
||||
) {
|
||||
// for API-response caching see https://trpc.io/docs/caching
|
||||
// console.log('cookies', parseCookies(event))
|
||||
|
||||
return {}
|
||||
}
|
||||
@@ -1,53 +0,0 @@
|
||||
import * as trpc from '@trpc/server'
|
||||
import type { inferAsyncReturnType } from '@trpc/server'
|
||||
import { z } from 'zod'
|
||||
import type { CompatibilityEvent } from 'h3'
|
||||
import { useCookies } from 'h3'
|
||||
|
||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||
|
||||
const TodoShape = z.object({
|
||||
userId: z.number(),
|
||||
id: z.number(),
|
||||
title: z.string(),
|
||||
completed: z.boolean(),
|
||||
})
|
||||
|
||||
export type Todo = z.infer<typeof TodoShape>
|
||||
|
||||
export const router = trpc.router<Context>()
|
||||
.query('getTodos', {
|
||||
async resolve() {
|
||||
return await $fetch<Todo[]>(`${baseURL}/todos`)
|
||||
},
|
||||
})
|
||||
.query('getTodo', {
|
||||
input: z.number(),
|
||||
async resolve(req) {
|
||||
return await $fetch<Todo>(`${baseURL}/todos/${req.input}`)
|
||||
},
|
||||
})
|
||||
.mutation('addTodo', {
|
||||
input: TodoShape,
|
||||
async resolve(req) {
|
||||
return await $fetch<Todo>(`${baseURL}/todos`, {
|
||||
method: 'POST',
|
||||
body: req.input,
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
export async function createContext(event: CompatibilityEvent) {
|
||||
// Create your context based on the request object
|
||||
// Will be available as `ctx` in all your resolvers
|
||||
|
||||
// This is just an example of something you'd might want to do in your ctx fn
|
||||
// const x = useCookies(event)
|
||||
console.log(event.req.headers)
|
||||
|
||||
return {
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
type Context = inferAsyncReturnType<typeof createContext>
|
||||
10
playground/server/trpc/routers/index.ts
Normal file
10
playground/server/trpc/routers/index.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import { router } from '../trpc'
|
||||
import { todoRouter } from './todo'
|
||||
import { userRouter } from './user'
|
||||
|
||||
export const appRouter = router({
|
||||
todo: todoRouter,
|
||||
user: userRouter
|
||||
})
|
||||
|
||||
export type AppRouter = typeof appRouter
|
||||
33
playground/server/trpc/routers/todo.ts
Normal file
33
playground/server/trpc/routers/todo.ts
Normal file
@@ -0,0 +1,33 @@
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||
|
||||
const TodoShape = z.object({
|
||||
userId: z.number(),
|
||||
id: z.number(),
|
||||
title: z.string(),
|
||||
completed: z.boolean()
|
||||
})
|
||||
|
||||
export type Todo = z.infer<typeof TodoShape>
|
||||
|
||||
export const todoRouter = router({
|
||||
getTodos: publicProcedure
|
||||
.query(() => {
|
||||
return $fetch<Todo[]>(`${baseURL}/todos`)
|
||||
}),
|
||||
getTodo: publicProcedure
|
||||
.input(z.number())
|
||||
.query((req) => {
|
||||
return $fetch<Todo>(`${baseURL}/todos/${req.input}`)
|
||||
}),
|
||||
addTodo: publicProcedure
|
||||
.input(TodoShape)
|
||||
.mutation((req) => {
|
||||
return $fetch<Todo>(`${baseURL}/todos`, {
|
||||
method: 'POST',
|
||||
body: req.input
|
||||
})
|
||||
})
|
||||
})
|
||||
33
playground/server/trpc/routers/user.ts
Normal file
33
playground/server/trpc/routers/user.ts
Normal file
@@ -0,0 +1,33 @@
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||
|
||||
const UserShape = z.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
email: z.string()
|
||||
})
|
||||
|
||||
export type User = z.infer<typeof UserShape>
|
||||
|
||||
export const userRouter = router({
|
||||
getUsers: publicProcedure
|
||||
.query(() => {
|
||||
return $fetch<User[]>(`${baseURL}/users`)
|
||||
}),
|
||||
getUser: publicProcedure
|
||||
.input(z.number())
|
||||
.query((req) => {
|
||||
return $fetch<User>(`${baseURL}/users/${req.input}`)
|
||||
}),
|
||||
addUser: publicProcedure
|
||||
.input(UserShape)
|
||||
.mutation((req) => {
|
||||
return $fetch<User>(`${baseURL}/users`, {
|
||||
method: 'POST',
|
||||
body: req.input
|
||||
})
|
||||
})
|
||||
})
|
||||
43
playground/server/trpc/trpc.ts
Normal file
43
playground/server/trpc/trpc.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { initTRPC } from '@trpc/server'
|
||||
import superjson from 'superjson'
|
||||
import { ZodError } from 'zod'
|
||||
import type { Context } from './context'
|
||||
|
||||
const t = initTRPC.context<Context>().create({
|
||||
transformer: superjson,
|
||||
errorFormatter ({ shape, error }) {
|
||||
return {
|
||||
...shape,
|
||||
data: {
|
||||
...shape.data,
|
||||
zodError:
|
||||
error.code === 'BAD_REQUEST' &&
|
||||
error.cause instanceof ZodError
|
||||
? error.cause!.flatten()
|
||||
: null
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
/**
|
||||
* Create a router
|
||||
* @see https://trpc.io/docs/v10/router
|
||||
*/
|
||||
export const router = t.router
|
||||
|
||||
/**
|
||||
* Create an unprotected procedure
|
||||
* @see https://trpc.io/docs/v10/procedures
|
||||
**/
|
||||
export const publicProcedure = t.procedure
|
||||
|
||||
/**
|
||||
* @see https://trpc.io/docs/v10/middlewares
|
||||
*/
|
||||
export const middleware = t.middleware
|
||||
|
||||
/**
|
||||
* @see https://trpc.io/docs/v10/merging-routers
|
||||
*/
|
||||
export const mergeRouters = t.mergeRouters
|
||||
4
playground/tsconfig.json
Normal file
4
playground/tsconfig.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
// https://v3.nuxtjs.org/concepts/typescript
|
||||
"extends": "./.nuxt/tsconfig.json"
|
||||
}
|
||||
10622
pnpm-lock.yaml
generated
10622
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,2 +1,3 @@
|
||||
packages:
|
||||
- playground/*
|
||||
- playground
|
||||
- docs
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
## Authorization
|
||||
|
||||
The `createContext`-function is called for each incoming request so here you can add contextual information about the calling user from the request object.
|
||||
|
||||
### Create context from request headers
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import type { inferAsyncReturnType } from '@trpc/server'
|
||||
import type { CompatibilityEvent } from 'h3'
|
||||
import { decodeAndVerifyJwtToken } from '~/somewhere/in/your/app/utils'
|
||||
|
||||
// The app's context - is generated for each incoming request
|
||||
export async function createContext({ req }: CompatibilityEvent) {
|
||||
// Create your context based on the request object
|
||||
// Will be available as `ctx` in all your resolvers
|
||||
|
||||
// This is just an example of something you'd might want to do in your ctx fn
|
||||
async function getUserFromHeader() {
|
||||
if (req.headers.authorization) {
|
||||
const user = await decodeAndVerifyJwtToken(req.headers.authorization.split(' ')[1])
|
||||
return user
|
||||
}
|
||||
return null
|
||||
}
|
||||
const user = await getUserFromHeader()
|
||||
|
||||
return {
|
||||
user,
|
||||
}
|
||||
}
|
||||
|
||||
type Context = inferAsyncReturnType<typeof createContext>
|
||||
|
||||
// [..] Define API handler and app router
|
||||
```
|
||||
|
||||
### Option 1: Authorize using resolver
|
||||
|
||||
```ts
|
||||
import { TRPCError } from '@trpc/server'
|
||||
|
||||
export const router = trpc
|
||||
.router<Context>()
|
||||
// open for anyone
|
||||
.query('hello', {
|
||||
input: z.string().nullish(),
|
||||
resolve: ({ input, ctx }) => {
|
||||
return `hello ${input ?? ctx.user?.name ?? 'world'}`
|
||||
},
|
||||
})
|
||||
// checked in resolver
|
||||
.query('secret', {
|
||||
resolve: ({ ctx }) => {
|
||||
if (!ctx.user)
|
||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||
|
||||
return {
|
||||
secret: 'sauce',
|
||||
}
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### Option 2: Authorize using middleware
|
||||
|
||||
```ts
|
||||
import * as trpc from '@trpc/server'
|
||||
import { TRPCError } from '@trpc/server'
|
||||
|
||||
// Merging routers: https://trpc.io/docs/merging-routers
|
||||
|
||||
export const router = trpc
|
||||
.router<Context>()
|
||||
// this is accessible for everyone
|
||||
.query('hello', {
|
||||
input: z.string().nullish(),
|
||||
resolve: ({ input, ctx }) => {
|
||||
return `hello ${input ?? ctx.user?.name ?? 'world'}`
|
||||
},
|
||||
})
|
||||
.merge(
|
||||
'admin.',
|
||||
trpc.router<Context>()
|
||||
// this protects all procedures defined next in this router
|
||||
.middleware(async ({ ctx, next }) => {
|
||||
if (!ctx.user?.isAdmin)
|
||||
throw new TRPCError({ code: 'UNAUTHORIZED' })
|
||||
|
||||
return next()
|
||||
})
|
||||
.query('secret', {
|
||||
resolve: ({ ctx }) => {
|
||||
return {
|
||||
secret: 'sauce',
|
||||
}
|
||||
},
|
||||
}),
|
||||
)
|
||||
```
|
||||
|
||||
Learn more about authorization [here](https://trpc.io/docs/authorization).
|
||||
@@ -1,41 +0,0 @@
|
||||
## Error Formatting
|
||||
|
||||
The error formatting in your router will be inferred all the way to your client (& Vue components).
|
||||
|
||||
### Adding custom formatting
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import * as trpc from '@trpc/server'
|
||||
|
||||
export const router = trpc.router<Context>()
|
||||
.formatError(({ shape, error }) => {
|
||||
return {
|
||||
...shape,
|
||||
data: {
|
||||
...shape.data,
|
||||
zodError:
|
||||
error.code === 'BAD_REQUEST'
|
||||
&& error.cause instanceof ZodError
|
||||
? error.cause.flatten()
|
||||
: null,
|
||||
}
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
### Usage in Vue
|
||||
|
||||
```html
|
||||
<script setup lang="ts">
|
||||
const { error } = await useAsyncQuery(['getUser', { id: 69 }])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<pre v-if="error?.data?.zodError">
|
||||
{{ JSON.stringify(error.data.zodError, null, 2) }}
|
||||
</pre>
|
||||
</template>
|
||||
```
|
||||
|
||||
Learn more about error formatting [here](https://trpc.io/docs/error-formatting).
|
||||
@@ -1,15 +0,0 @@
|
||||
## Handling errors
|
||||
|
||||
All errors that occur in a procedure go through the `onError` method before being sent to the client. Here you can handle or change errors.
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import * as trpc from '@trpc/server'
|
||||
|
||||
export function onError({ error, type, path, input, ctx, req }) {
|
||||
console.error('Error:', error)
|
||||
if (error.code === 'INTERNAL_SERVER_ERROR') {
|
||||
// send to bug reporting
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -1,80 +0,0 @@
|
||||
## Inference Helpers
|
||||
|
||||
`@trpc/server` exports the following helper types to assist with inferring these types from the `router` exported in `~/server/trpc/index.ts`:
|
||||
|
||||
- `inferProcedureOutput<TProcedure>`
|
||||
- `inferProcedureInput<TProcedure>`
|
||||
- `inferSubscriptionOutput<TRouter, TPath>`
|
||||
|
||||
```ts
|
||||
// ~/utils/trpc.ts
|
||||
import type { router } from '~/server/trpc/index.ts'
|
||||
|
||||
type AppRouter = typeof router
|
||||
|
||||
/**
|
||||
* Enum containing all api query paths
|
||||
*/
|
||||
export type TQuery = keyof AppRouter['_def']['queries']
|
||||
|
||||
/**
|
||||
* Enum containing all api mutation paths
|
||||
*/
|
||||
export type TMutation = keyof AppRouter['_def']['mutations']
|
||||
|
||||
/**
|
||||
* Enum containing all api subscription paths
|
||||
*/
|
||||
export type TSubscription = keyof AppRouter['_def']['subscriptions']
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the output of a query resolver
|
||||
* @example type HelloOutput = InferQueryOutput<'hello'>
|
||||
*/
|
||||
export type InferQueryOutput<TRouteKey extends TQuery> = inferProcedureOutput<
|
||||
AppRouter['_def']['queries'][TRouteKey]
|
||||
>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the input of a query resolver
|
||||
* @example type HelloInput = InferQueryInput<'hello'>
|
||||
*/
|
||||
export type InferQueryInput<TRouteKey extends TQuery> = inferProcedureInput<
|
||||
AppRouter['_def']['queries'][TRouteKey]
|
||||
>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the output of a mutation resolver
|
||||
* @example type HelloOutput = InferMutationOutput<'hello'>
|
||||
*/
|
||||
export type InferMutationOutput<TRouteKey extends TMutation> =
|
||||
inferProcedureOutput<AppRouter['_def']['mutations'][TRouteKey]>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the input of a mutation resolver
|
||||
* @example type HelloInput = InferMutationInput<'hello'>
|
||||
*/
|
||||
export type InferMutationInput<TRouteKey extends TMutation> =
|
||||
inferProcedureInput<AppRouter['_def']['mutations'][TRouteKey]>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the output of a subscription resolver
|
||||
* @example type HelloOutput = InferSubscriptionOutput<'hello'>
|
||||
*/
|
||||
export type InferSubscriptionOutput<TRouteKey extends TSubscription> =
|
||||
inferProcedureOutput<AppRouter['_def']['subscriptions'][TRouteKey]>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the asynchronous output of a subscription resolver
|
||||
* @example type HelloAsyncOutput = InferAsyncSubscriptionOutput<'hello'>
|
||||
*/
|
||||
export type InferAsyncSubscriptionOutput<TRouteKey extends TSubscription> =
|
||||
inferSubscriptionOutput<AppRouter, TRouteKey>
|
||||
|
||||
/**
|
||||
* This is a helper method to infer the input of a subscription resolver
|
||||
* @example type HelloInput = InferSubscriptionInput<'hello'>
|
||||
*/
|
||||
export type InferSubscriptionInput<TRouteKey extends TSubscription> =
|
||||
inferProcedureInput<AppRouter['_def']['subscriptions'][TRouteKey]>
|
||||
```
|
||||
@@ -1,46 +0,0 @@
|
||||
# Merging Routers
|
||||
|
||||
Writing all API-code in your code in the same file is not a great idea. It's easy to merge routers with other routers.
|
||||
|
||||
Define your routes:
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/routes/posts.ts
|
||||
export const posts = trpc.router()
|
||||
.query('list', {
|
||||
resolve() {
|
||||
// ..
|
||||
return []
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/routes/users.ts
|
||||
export const users = trpc.router()
|
||||
.query('list', {
|
||||
resolve() {
|
||||
// ..
|
||||
return []
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import { users } from './routes/users'
|
||||
import { posts } from './routes/posts'
|
||||
|
||||
export const router = trpc.router()
|
||||
.merge('user.', users) // prefix user procedures with "user."
|
||||
.merge('post.', posts) // prefix post procedures with "post."
|
||||
```
|
||||
|
||||
and use it like this:
|
||||
|
||||
```html
|
||||
<script setup lang="ts">
|
||||
const { data: users } = await useAsyncQuery(['user.list'])
|
||||
const { data: posts } = await useAsyncQuery(['post.list'])
|
||||
</script>
|
||||
```
|
||||
@@ -1,49 +0,0 @@
|
||||
## Validation
|
||||
|
||||
tRPC works out-of-the-box with yup/superstruct/zod/myzod/custom validators.
|
||||
|
||||
### Input Validation
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import { z } from 'zod'
|
||||
|
||||
export const router = trpc
|
||||
.router()
|
||||
.mutation('createUser', {
|
||||
// validate input with Zod
|
||||
input: z.object({
|
||||
name: z.string().min(5)
|
||||
}),
|
||||
async resolve(req) {
|
||||
// use your ORM of choice
|
||||
return await UserModel.create({
|
||||
data: req.input,
|
||||
})
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
### Output Validation
|
||||
|
||||
```ts
|
||||
// ~/server/trpc/index.ts
|
||||
import { z } from 'zod'
|
||||
|
||||
export const router = trpc
|
||||
.router()
|
||||
.query('hello', {
|
||||
// validate output with Zod
|
||||
output: z.object({
|
||||
greeting: z.string()
|
||||
}),
|
||||
// expects return type of { greeting: string }
|
||||
resolve() {
|
||||
return {
|
||||
greeting: 'hello!',
|
||||
}
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
Learn more about input validation [here](https://trpc.io/docs/router#input-validation).
|
||||
81
src/client/index.ts
Normal file
81
src/client/index.ts
Normal file
@@ -0,0 +1,81 @@
|
||||
import { type CreateTRPCClientOptions, type inferRouterProxyClient, createTRPCProxyClient } from '@trpc/client'
|
||||
import { type AnyRouter } from '@trpc/server'
|
||||
import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
|
||||
import { hash } from 'ohash'
|
||||
import { type DecoratedProcedureRecord } from './types'
|
||||
// @ts-expect-error: Nuxt auto-imports
|
||||
import { getCurrentInstance, onScopeDispose, useAsyncData, unref } from '#imports'
|
||||
|
||||
/**
|
||||
* Calculates the key used for `useAsyncData` call.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* ```ts
|
||||
* import { getQueryKey } from 'trpc-nuxt/client'
|
||||
*
|
||||
* $client.todo.getTodo(1)
|
||||
*
|
||||
* const queryKey = getQueryKey('todo.getTodo', 1)
|
||||
* ```
|
||||
*/
|
||||
export function getQueryKey (
|
||||
path: string,
|
||||
input: unknown
|
||||
): string {
|
||||
return input === undefined ? path : `${path}-${hash(input || '')}`
|
||||
}
|
||||
|
||||
export function createNuxtProxyDecoration<TRouter extends AnyRouter> (name: string, client: inferRouterProxyClient<TRouter>) {
|
||||
return createRecursiveProxy((opts) => {
|
||||
const args = opts.args
|
||||
|
||||
const pathCopy = [name, ...opts.path]
|
||||
|
||||
// The last arg is for instance `.useMutation` or `.useQuery()`
|
||||
const lastArg = pathCopy.pop()!
|
||||
|
||||
// The `path` ends up being something like `post.byId`
|
||||
const path = pathCopy.join('.')
|
||||
|
||||
const [input, otherOptions] = args
|
||||
|
||||
if (lastArg === 'useQuery') {
|
||||
const { trpc, ...asyncDataOptions } = otherOptions || {} as any
|
||||
|
||||
let controller: AbortController
|
||||
|
||||
if (trpc?.abortOnUnmount) {
|
||||
if (getCurrentInstance()) {
|
||||
onScopeDispose(() => {
|
||||
controller?.abort?.()
|
||||
})
|
||||
}
|
||||
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
|
||||
}
|
||||
|
||||
const queryKey = getQueryKey(path, unref(input))
|
||||
return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
|
||||
signal: controller?.signal,
|
||||
...trpc
|
||||
}), asyncDataOptions)
|
||||
}
|
||||
|
||||
return (client as any)[path][lastArg](...args)
|
||||
})
|
||||
}
|
||||
|
||||
export function createTRPCNuxtClient<TRouter extends AnyRouter> (opts: CreateTRPCClientOptions<TRouter>) {
|
||||
const client = createTRPCProxyClient<TRouter>(opts)
|
||||
|
||||
const decoratedClient = createFlatProxy((key) => {
|
||||
return createNuxtProxyDecoration(key, client as any)
|
||||
}) as DecoratedProcedureRecord<TRouter['_def']['record'], TRouter>
|
||||
|
||||
return decoratedClient
|
||||
}
|
||||
|
||||
export {
|
||||
httpBatchLink,
|
||||
httpLink
|
||||
} from './links'
|
||||
80
src/client/links.ts
Normal file
80
src/client/links.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
import { httpLink as _httpLink, httpBatchLink as _httpBatchLink } from '@trpc/client'
|
||||
import { type AnyRouter } from '@trpc/server'
|
||||
import { FetchError } from 'ofetch'
|
||||
// @ts-expect-error: Nuxt auto-imports
|
||||
import { useRequestHeaders } from '#imports'
|
||||
import { type HTTPLinkOptions as _HTTPLinkOptions } from '@trpc/client/dist/links/httpLink'
|
||||
import { type FetchEsque } from '@trpc/client/dist/internals/types'
|
||||
|
||||
function customFetch(input: RequestInfo | URL, init?: RequestInit & { method: 'GET' }) {
|
||||
return globalThis.$fetch.raw(input.toString(), init)
|
||||
.catch((e) => {
|
||||
if (e instanceof FetchError && e.response) { return e.response }
|
||||
throw e
|
||||
})
|
||||
.then(response => ({
|
||||
...response,
|
||||
json: () => Promise.resolve(response._data)
|
||||
}))
|
||||
}
|
||||
|
||||
export interface HTTPLinkOptions extends _HTTPLinkOptions {
|
||||
/**
|
||||
* Select headers to pass to `useRequestHeaders`.
|
||||
*/
|
||||
pickHeaders?: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
* This is a convenience wrapper around the original httpLink
|
||||
* that replaces regular `fetch` with a `$fetch` from Nuxt. It
|
||||
* also sets the default headers based on `useRequestHeaders` values.
|
||||
*
|
||||
* During server-side rendering, calling $fetch to fetch your internal API routes
|
||||
* will directly call the relevant function (emulating the request),
|
||||
* saving an additional API call.
|
||||
*
|
||||
* @see https://nuxt.com/docs/api/utils/dollarfetch
|
||||
*/
|
||||
export function httpLink<TRouter extends AnyRouter>(opts?: HTTPLinkOptions) {
|
||||
const headers = useRequestHeaders(opts?.pickHeaders)
|
||||
|
||||
return _httpLink<TRouter>({
|
||||
url: '/api/trpc',
|
||||
headers () {
|
||||
return headers
|
||||
},
|
||||
fetch: customFetch as FetchEsque,
|
||||
...opts,
|
||||
})
|
||||
}
|
||||
|
||||
export interface HttpBatchLinkOptions extends HTTPLinkOptions {
|
||||
maxURLLength?: number;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* This is a convenience wrapper around the original httpBatchLink
|
||||
* that replaces regular `fetch` with a `$fetch` from Nuxt. It
|
||||
* also sets the default headers based on `useRequestHeaders` values.
|
||||
*
|
||||
* During server-side rendering, calling $fetch to fetch your internal API routes
|
||||
* will directly call the relevant function (emulating the request),
|
||||
* saving an additional API call.
|
||||
*
|
||||
* @see https://nuxt.com/docs/api/utils/dollarfetch
|
||||
*/
|
||||
export function httpBatchLink<TRouter extends AnyRouter>(opts?: HttpBatchLinkOptions) {
|
||||
const headers = useRequestHeaders(opts?.pickHeaders)
|
||||
|
||||
return _httpBatchLink<TRouter>({
|
||||
url: '/api/trpc',
|
||||
// @ts-expect-error: Missing property from batchLink. Fix this later.
|
||||
headers () {
|
||||
return headers
|
||||
},
|
||||
fetch: customFetch as FetchEsque,
|
||||
...opts,
|
||||
})
|
||||
}
|
||||
83
src/client/types.ts
Normal file
83
src/client/types.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import type { TRPCClientErrorLike, TRPCRequestOptions as _TRPCRequestOptions } from '@trpc/client'
|
||||
import { type TRPCSubscriptionObserver } from '@trpc/client/dist/internals/TRPCUntypedClient'
|
||||
import type {
|
||||
AnyMutationProcedure,
|
||||
AnyProcedure,
|
||||
AnyQueryProcedure,
|
||||
AnyRouter,
|
||||
ProcedureRouterRecord,
|
||||
inferProcedureInput,
|
||||
inferProcedureOutput,
|
||||
ProcedureArgs,
|
||||
AnySubscriptionProcedure
|
||||
} from '@trpc/server'
|
||||
import { type inferObservableValue, type Unsubscribable } from '@trpc/server/observable'
|
||||
import { inferTransformedProcedureOutput } from '@trpc/server/shared'
|
||||
import type {
|
||||
AsyncData,
|
||||
AsyncDataOptions,
|
||||
KeysOf,
|
||||
PickFrom,
|
||||
} from 'nuxt/dist/app/composables/asyncData'
|
||||
import type { Ref } from 'vue'
|
||||
|
||||
interface TRPCRequestOptions extends _TRPCRequestOptions {
|
||||
abortOnUnmount?: boolean
|
||||
}
|
||||
|
||||
type Resolver<TProcedure extends AnyProcedure> = (
|
||||
...args: ProcedureArgs<TProcedure['_def']>
|
||||
) => Promise<inferTransformedProcedureOutput<TProcedure>>;
|
||||
|
||||
type SubscriptionResolver<
|
||||
TProcedure extends AnyProcedure,
|
||||
TRouter extends AnyRouter,
|
||||
> = (
|
||||
...args: [
|
||||
input: ProcedureArgs<TProcedure['_def']>[0],
|
||||
opts: ProcedureArgs<TProcedure['_def']>[1] &
|
||||
Partial<
|
||||
TRPCSubscriptionObserver<
|
||||
inferObservableValue<inferProcedureOutput<TProcedure>>,
|
||||
TRPCClientErrorLike<TRouter>
|
||||
>
|
||||
>,
|
||||
]
|
||||
) => Unsubscribable
|
||||
|
||||
type MaybeRef<T> = T | Ref<T>
|
||||
|
||||
type DecorateProcedure<
|
||||
TProcedure extends AnyProcedure,
|
||||
TRouter extends AnyRouter,
|
||||
> = TProcedure extends AnyQueryProcedure
|
||||
? {
|
||||
useQuery: <
|
||||
ResT = inferTransformedProcedureOutput<TProcedure>,
|
||||
DataE = TRPCClientErrorLike<TProcedure>,
|
||||
DataT = ResT,
|
||||
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
||||
>(
|
||||
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
||||
opts?: AsyncDataOptions<ResT, DataT, PickKeys> & { trpc?: TRPCRequestOptions },
|
||||
) => AsyncData<PickFrom<DataT, PickKeys>, DataE>,
|
||||
query: Resolver<TProcedure>
|
||||
} : TProcedure extends AnyMutationProcedure ? {
|
||||
mutate: Resolver<TProcedure>
|
||||
} : TProcedure extends AnySubscriptionProcedure ? {
|
||||
subscribe: SubscriptionResolver<TProcedure, TRouter>
|
||||
} : never
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
export type DecoratedProcedureRecord<
|
||||
TProcedures extends ProcedureRouterRecord,
|
||||
TRouter extends AnyRouter,
|
||||
> = {
|
||||
[TKey in keyof TProcedures]: TProcedures[TKey] extends AnyRouter
|
||||
? DecoratedProcedureRecord<TProcedures[TKey]['_def']['record'], TRouter>
|
||||
: TProcedures[TKey] extends AnyProcedure
|
||||
? DecorateProcedure<TProcedures[TKey], TRouter>
|
||||
: never;
|
||||
}
|
||||
132
src/index.ts
Normal file
132
src/index.ts
Normal file
@@ -0,0 +1,132 @@
|
||||
import type { ResponseMeta } from '@trpc/server/http'
|
||||
import { resolveHTTPResponse } from '@trpc/server/http'
|
||||
import type {
|
||||
AnyRouter,
|
||||
ProcedureType,
|
||||
inferRouterContext,
|
||||
inferRouterError
|
||||
} from '@trpc/server'
|
||||
import {
|
||||
TRPCError
|
||||
} from '@trpc/server'
|
||||
import { createURL } from 'ufo'
|
||||
import type { H3Event } from 'h3'
|
||||
import { createError, defineEventHandler, isMethod, readBody } from 'h3'
|
||||
import type { TRPCResponse } from '@trpc/server/rpc'
|
||||
|
||||
type MaybePromise<T> = T | Promise<T>
|
||||
|
||||
export type CreateContextFn<TRouter extends AnyRouter> = (event: H3Event) => MaybePromise<inferRouterContext<TRouter>>
|
||||
|
||||
export interface ResponseMetaFnPayload<TRouter extends AnyRouter> {
|
||||
data: TRPCResponse<unknown, inferRouterError<TRouter>>[]
|
||||
ctx?: inferRouterContext<TRouter>
|
||||
paths?: string[]
|
||||
type: ProcedureType | 'unknown'
|
||||
errors: TRPCError[]
|
||||
}
|
||||
|
||||
export type ResponseMetaFn<TRouter extends AnyRouter> = (opts: ResponseMetaFnPayload<TRouter>) => ResponseMeta
|
||||
|
||||
export interface OnErrorPayload<TRouter extends AnyRouter> {
|
||||
error: TRPCError
|
||||
type: ProcedureType | 'unknown'
|
||||
path: string | undefined
|
||||
req: H3Event['node']['req']
|
||||
input: unknown
|
||||
ctx: undefined | inferRouterContext<TRouter>
|
||||
}
|
||||
|
||||
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
||||
|
||||
export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
||||
router: TRouter
|
||||
createContext?: CreateContextFn<TRouter>
|
||||
responseMeta?: ResponseMetaFn<TRouter>
|
||||
onError?: OnErrorFn<TRouter>
|
||||
batching?: {
|
||||
enabled: boolean
|
||||
}
|
||||
}
|
||||
|
||||
function getPath (event: H3Event): string | null {
|
||||
const { params } = event.context
|
||||
|
||||
if (typeof params?.trpc === 'string') { return params.trpc }
|
||||
|
||||
if (params?.trpc && Array.isArray(params.trpc)) {
|
||||
return (params.trpc as string[]).join('/')
|
||||
}
|
||||
|
||||
return null
|
||||
}
|
||||
|
||||
export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
||||
router,
|
||||
createContext,
|
||||
responseMeta,
|
||||
onError,
|
||||
batching
|
||||
}: ResolveHTTPRequestOptions<TRouter>) {
|
||||
return defineEventHandler(async (event) => {
|
||||
const {
|
||||
req,
|
||||
res
|
||||
} = event.node
|
||||
|
||||
const $url = createURL(req.url!)
|
||||
|
||||
const path = getPath(event)
|
||||
|
||||
if (path === null) {
|
||||
const error = router.getErrorShape({
|
||||
error: new TRPCError({
|
||||
message:
|
||||
'Param "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
|
||||
code: 'INTERNAL_SERVER_ERROR'
|
||||
}),
|
||||
type: 'unknown',
|
||||
ctx: undefined,
|
||||
path: undefined,
|
||||
input: undefined
|
||||
})
|
||||
|
||||
throw createError({
|
||||
statusCode: 500,
|
||||
statusMessage: JSON.stringify(error)
|
||||
})
|
||||
}
|
||||
|
||||
const httpResponse = await resolveHTTPResponse({
|
||||
batching,
|
||||
router,
|
||||
req: {
|
||||
method: req.method!,
|
||||
headers: req.headers,
|
||||
body: isMethod(event, 'GET') ? null : await readBody(event),
|
||||
query: $url.searchParams
|
||||
},
|
||||
path,
|
||||
createContext: async () => await createContext?.(event),
|
||||
responseMeta,
|
||||
onError: (o) => {
|
||||
onError?.({
|
||||
...o,
|
||||
req
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
const { status, headers, body } = httpResponse
|
||||
|
||||
res.statusCode = status
|
||||
|
||||
headers && Object.keys(headers).forEach((key) => {
|
||||
res.setHeader(key, headers[key]!)
|
||||
})
|
||||
|
||||
return body
|
||||
})
|
||||
}
|
||||
|
||||
export const createH3ApiHandler = createNuxtApiHandler
|
||||
@@ -1,69 +0,0 @@
|
||||
import { fileURLToPath } from 'url'
|
||||
import { join, resolve } from 'pathe'
|
||||
import { defu } from 'defu'
|
||||
|
||||
import { addPlugin, addServerHandler, addTemplate, defineNuxtModule } from '@nuxt/kit'
|
||||
|
||||
export interface ModuleOptions {
|
||||
baseURL: string
|
||||
trpcURL: string
|
||||
}
|
||||
|
||||
export default defineNuxtModule<ModuleOptions>({
|
||||
meta: {
|
||||
name: 'trpc-nuxt',
|
||||
configKey: 'trpc',
|
||||
},
|
||||
defaults: {
|
||||
baseURL: 'http://localhost:3000',
|
||||
trpcURL: '/api/trpc',
|
||||
},
|
||||
async setup(options, nuxt) {
|
||||
const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
|
||||
nuxt.options.build.transpile.push(runtimeDir, '#build/trpc-handler')
|
||||
|
||||
const handlerPath = join(nuxt.options.buildDir, 'trpc-handler.ts')
|
||||
const trpcOptionsPath = join(nuxt.options.rootDir, 'server/trpc')
|
||||
|
||||
// Add vueuse
|
||||
nuxt.options.modules.push('@vueuse/nuxt')
|
||||
|
||||
// Final resolved configuration
|
||||
const finalConfig = nuxt.options.runtimeConfig.public.trpc = defu(nuxt.options.runtimeConfig.public.trpc, {
|
||||
baseURL: options.baseURL,
|
||||
trpcURL: options.trpcURL,
|
||||
})
|
||||
|
||||
nuxt.hook('autoImports:extend', (imports) => {
|
||||
imports.push(
|
||||
{ name: 'useClient', from: join(runtimeDir, 'client') },
|
||||
{ name: 'useAsyncQuery', from: join(runtimeDir, 'client') },
|
||||
{ name: 'useClientHeaders', from: join(runtimeDir, 'client') },
|
||||
)
|
||||
})
|
||||
|
||||
addServerHandler({
|
||||
route: `${finalConfig.trpcURL}/*`,
|
||||
handler: handlerPath,
|
||||
})
|
||||
|
||||
addPlugin(resolve(runtimeDir, 'plugin'))
|
||||
|
||||
addTemplate({
|
||||
filename: 'trpc-handler.ts',
|
||||
write: true,
|
||||
getContents() {
|
||||
return `
|
||||
import { createTRPCHandler } from 'trpc-nuxt/api'
|
||||
import * as functions from '${trpcOptionsPath}'
|
||||
|
||||
export default createTRPCHandler({
|
||||
...functions,
|
||||
trpcURL: '${finalConfig.trpcURL}'
|
||||
})
|
||||
`
|
||||
},
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
@@ -1,90 +0,0 @@
|
||||
import { resolveHTTPResponse } from '@trpc/server'
|
||||
import type {
|
||||
AnyRouter,
|
||||
ProcedureType,
|
||||
ResponseMeta,
|
||||
TRPCError,
|
||||
inferRouterContext,
|
||||
inferRouterError,
|
||||
} from '@trpc/server'
|
||||
import { createURL } from 'ufo'
|
||||
import type { CompatibilityEvent } from 'h3'
|
||||
import { defineEventHandler, isMethod, useBody } from 'h3'
|
||||
import type { TRPCResponse } from '@trpc/server/dist/declarations/src/rpc'
|
||||
|
||||
type MaybePromise<T> = T | Promise<T>
|
||||
|
||||
export type CreateContextFn<TRouter extends AnyRouter> = (event: CompatibilityEvent) => MaybePromise<inferRouterContext<TRouter>>
|
||||
|
||||
export interface ResponseMetaFnPayload<TRouter extends AnyRouter> {
|
||||
data: TRPCResponse<unknown, inferRouterError<TRouter>>[]
|
||||
ctx?: inferRouterContext<TRouter>
|
||||
paths?: string[]
|
||||
type: ProcedureType | 'unknown'
|
||||
errors: TRPCError[]
|
||||
}
|
||||
|
||||
export type ResponseMetaFn<TRouter extends AnyRouter> = (opts: ResponseMetaFnPayload<TRouter>) => ResponseMeta
|
||||
|
||||
export interface OnErrorPayload<TRouter extends AnyRouter> {
|
||||
error: TRPCError
|
||||
type: ProcedureType | 'unknown'
|
||||
path: string | undefined
|
||||
req: CompatibilityEvent['req']
|
||||
input: unknown
|
||||
ctx: undefined | inferRouterContext<TRouter>
|
||||
}
|
||||
|
||||
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
||||
|
||||
export function createTRPCHandler<Router extends AnyRouter>({
|
||||
router,
|
||||
createContext,
|
||||
responseMeta,
|
||||
onError,
|
||||
trpcURL,
|
||||
}: {
|
||||
router: Router
|
||||
createContext?: CreateContextFn<Router>
|
||||
responseMeta?: ResponseMetaFn<Router>
|
||||
onError?: OnErrorFn<Router>
|
||||
trpcURL: string
|
||||
}) {
|
||||
return defineEventHandler(async (event) => {
|
||||
const {
|
||||
req,
|
||||
res,
|
||||
} = event
|
||||
|
||||
const $url = createURL(req.url)
|
||||
|
||||
const httpResponse = await resolveHTTPResponse({
|
||||
router,
|
||||
req: {
|
||||
method: req.method,
|
||||
headers: req.headers,
|
||||
body: isMethod(event, 'GET') ? null : await useBody(event),
|
||||
query: $url.searchParams,
|
||||
},
|
||||
path: $url.pathname.substring(trpcURL.length + 1),
|
||||
createContext: async () => createContext?.(event),
|
||||
responseMeta,
|
||||
onError: (o) => {
|
||||
onError?.({
|
||||
...o,
|
||||
req,
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
const { status, headers, body } = httpResponse
|
||||
|
||||
res.statusCode = status
|
||||
|
||||
Object.keys(headers).forEach((key) => {
|
||||
res.setHeader(key, headers[key])
|
||||
})
|
||||
|
||||
return body
|
||||
})
|
||||
}
|
||||
@@ -1,89 +0,0 @@
|
||||
import type {
|
||||
AsyncData,
|
||||
AsyncDataOptions,
|
||||
KeyOfRes,
|
||||
PickFrom,
|
||||
_Transform,
|
||||
} from 'nuxt/dist/app/composables/asyncData'
|
||||
import type { ProcedureRecord, inferHandlerInput, inferProcedureInput, inferProcedureOutput } from '@trpc/server'
|
||||
import type { TRPCClient, TRPCClientErrorLike } from '@trpc/client'
|
||||
import { objectHash } from 'ohash'
|
||||
import type { MaybeRef } from '@vueuse/core'
|
||||
import { useStorage } from '@vueuse/core'
|
||||
import { useAsyncData, useNuxtApp, useState } from '#app'
|
||||
import type { router } from '~/server/trpc'
|
||||
|
||||
type AppRouter = typeof router
|
||||
|
||||
export type inferProcedures<
|
||||
TObj extends ProcedureRecord<any, any, any, any, any, any>,
|
||||
> = {
|
||||
[TPath in keyof TObj]: {
|
||||
input: inferProcedureInput<TObj[TPath]>
|
||||
output: inferProcedureOutput<TObj[TPath]>
|
||||
};
|
||||
}
|
||||
|
||||
export type TQueries = AppRouter['_def']['queries']
|
||||
export type TError = TRPCClientErrorLike<AppRouter>
|
||||
|
||||
export type TQueryValues = inferProcedures<AppRouter['_def']['queries']>
|
||||
|
||||
/**
|
||||
* Additional header properties to pass to tRPC client.
|
||||
*
|
||||
* @see https://trpc.io/docs/vanilla
|
||||
* @param pathAndInput tRPC client path and input.
|
||||
* @param options Options to pass to useAsyncData.
|
||||
*/
|
||||
export async function useAsyncQuery<
|
||||
TPath extends keyof TQueryValues & string,
|
||||
TOutput extends TQueryValues[TPath]['output'] = TQueryValues[TPath]['output'],
|
||||
Transform extends _Transform<TOutput> = _Transform<TOutput, TOutput>,
|
||||
PickKeys extends KeyOfRes<Transform> = KeyOfRes<Transform>,
|
||||
>(
|
||||
pathAndInput: [path: TPath, ...args: inferHandlerInput<TQueries[TPath]>],
|
||||
options: AsyncDataOptions<TOutput, Transform, PickKeys> = {},
|
||||
): Promise<AsyncData<PickFrom<ReturnType<Transform>, PickKeys>, TError>> {
|
||||
const { $client } = useNuxtApp()
|
||||
const key = `${pathAndInput[0]}-${objectHash(pathAndInput[1] ? JSON.stringify(pathAndInput[1]) : '')}`
|
||||
const serverError = useState<TError | null>(`error-${key}`, () => null)
|
||||
const { error, data, ...rest } = await useAsyncData(
|
||||
key,
|
||||
() => $client.query(...pathAndInput),
|
||||
// @ts-expect-error: Internal
|
||||
options,
|
||||
)
|
||||
|
||||
if (process.server && error.value && !serverError.value)
|
||||
serverError.value = error.value as any
|
||||
|
||||
if (data.value)
|
||||
serverError.value = null
|
||||
|
||||
return {
|
||||
...rest,
|
||||
data,
|
||||
error: serverError,
|
||||
} as any
|
||||
}
|
||||
|
||||
/**
|
||||
* tRPC Client.
|
||||
*
|
||||
* @see https://trpc.io/docs/vanilla
|
||||
*/
|
||||
export function useClient(): TRPCClient<AppRouter> {
|
||||
const { $client } = useNuxtApp()
|
||||
return $client
|
||||
}
|
||||
|
||||
/**
|
||||
* Additional header properties to pass to tRPC client.
|
||||
*
|
||||
* @see https://github.com/trpc/trpc/discussions/1686
|
||||
* @param initialValue
|
||||
*/
|
||||
export function useClientHeaders(initialValue?: MaybeRef<Record<string, any>>) {
|
||||
return useStorage('trpc-nuxt-header', initialValue || {})
|
||||
}
|
||||
@@ -1,30 +0,0 @@
|
||||
import * as trpc from '@trpc/client'
|
||||
import { unref } from 'vue'
|
||||
import { useClientHeaders } from './client'
|
||||
import { defineNuxtPlugin, useRequestHeaders, useRuntimeConfig } from '#app'
|
||||
import type { router } from '~/server/trpc'
|
||||
|
||||
declare type AppRouter = typeof router
|
||||
|
||||
export default defineNuxtPlugin((nuxtApp) => {
|
||||
const config = useRuntimeConfig().public.trpc
|
||||
const headers = useRequestHeaders()
|
||||
const otherHeaders = useClientHeaders()
|
||||
const client = trpc.createTRPCClient<AppRouter>({
|
||||
url: `${config.baseURL}${config.trpcURL}`,
|
||||
headers: () => {
|
||||
return {
|
||||
...unref(otherHeaders),
|
||||
...headers,
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
nuxtApp.provide('client', client)
|
||||
})
|
||||
|
||||
declare module '#app' {
|
||||
interface NuxtApp {
|
||||
$client: trpc.TRPCClient<AppRouter>
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,16 @@
|
||||
{
|
||||
"extends": "./playground/.nuxt/tsconfig.json"
|
||||
"compilerOptions": {
|
||||
"target": "es2020",
|
||||
"module": "esnext",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"moduleResolution": "node",
|
||||
"skipLibCheck": true,
|
||||
"noUnusedLocals": true,
|
||||
"noImplicitAny": true,
|
||||
"allowJs": true,
|
||||
"noEmit": true,
|
||||
"resolveJsonModule": true,
|
||||
"skipDefaultLibCheck": true
|
||||
}
|
||||
}
|
||||
|
||||
15
tsup.config.ts
Normal file
15
tsup.config.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { defineConfig } from 'tsup'
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/index.ts', 'src/client/index.ts'],
|
||||
format: ['cjs', 'esm'],
|
||||
splitting: false,
|
||||
clean: true,
|
||||
external: ['#app', '#imports', /@trpc\/client/, /@trpc\/server/],
|
||||
dts: true,
|
||||
outExtension ({ format }) {
|
||||
return {
|
||||
js: format === 'esm' ? '.mjs' : `.${format}`
|
||||
}
|
||||
}
|
||||
})
|
||||
Reference in New Issue
Block a user