mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 12:14:40 +01:00
Compare commits
165 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ec7e0255c2 | ||
|
|
1386832b4a | ||
|
|
120ebc5760 | ||
|
|
adeb5a5afd | ||
|
|
6e47431f35 | ||
|
|
7c9392b209 | ||
|
|
117f7b791f | ||
|
|
735e362958 | ||
|
|
0738a133ca | ||
|
|
97ef8c90b8 | ||
|
|
bec300b750 | ||
|
|
7bbe767495 | ||
|
|
811a634010 | ||
|
|
12d8c97f71 | ||
|
|
3fc261d5e7 | ||
|
|
ad85a78350 | ||
|
|
892d167ff1 | ||
|
|
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 | ||
|
|
1c638a8489 | ||
|
|
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 |
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1 @@
|
||||
github: wobsoriano
|
||||
77
CHANGELOG.md
Normal file
77
CHANGELOG.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## v0.10.7
|
||||
|
||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.6...v0.10.7)
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Make useQuery return data nullable ([120ebc5](https://github.com/wobsoriano/trpc-nuxt/commit/120ebc5))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update Server Side Calls docs ([1c638a8](https://github.com/wobsoriano/trpc-nuxt/commit/1c638a8))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Blechlawine <marczinser@gmx.de>
|
||||
- Colonel-Sandvich
|
||||
|
||||
## v0.10.6
|
||||
|
||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.5...v0.10.6)
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- **deps**:
|
||||
- Bump h3 to 1.7.1 - by @wobsoriano [<samp>(12d8c)</samp>](https://github.com/wobsoriano/trpc-nuxt/commit/12d8c97f71bedb025b2e7914db13e69e5f62c8a2)
|
||||
- Bump ofetch to 1.1.1 - by @wobsoriano [<samp>(811a6)</samp>](https://github.com/wobsoriano/trpc-nuxt/commit/811a6340107a2bea53f2cf488416bcec915f88b0)
|
||||
|
||||
## v0.10.5
|
||||
|
||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.4...v0.10.5)
|
||||
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Pass input to watched sources if it's a ref ([892d167](https://github.com/wobsoriano/trpc-nuxt/commit/892d167))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||
|
||||
## 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))
|
||||
|
||||
23
README.md
23
README.md
@@ -1,14 +1,35 @@
|
||||
<p align="center">
|
||||
<figure>
|
||||
<img src="https://trpc-nuxt.vercel.app/cover.jpg" alt="trpc-nuxt cover image" />
|
||||
</figure>
|
||||
</p>
|
||||
|
||||
# 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/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.
|
||||
</p>
|
||||
</figcaption>
|
||||
</figure>
|
||||
</p>
|
||||
|
||||
Docs: https://trpc-nuxt.vercel.app
|
||||
|
||||
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,26 +1,38 @@
|
||||
export default defineAppConfig({
|
||||
docus: {
|
||||
title: 'tRPC Nuxt',
|
||||
image: 'https://og-image.vercel.app/tRPC-Nuxt',
|
||||
alt: 'tRPC-Nuxt cover',
|
||||
url: 'https://trpc-nuxt.vercel.app',
|
||||
debug: false,
|
||||
aside: {
|
||||
level: 1
|
||||
},
|
||||
footer: {
|
||||
credits: {
|
||||
icon: 'IconDocus',
|
||||
text: 'Powered by Docus',
|
||||
href: 'https://docus.com'
|
||||
},
|
||||
icons: [
|
||||
{
|
||||
label: 'NuxtJS',
|
||||
href: 'https://nuxtjs.org',
|
||||
component: 'IconNuxt'
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
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>
|
||||
@@ -8,19 +8,27 @@ description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
::code-group
|
||||
|
||||
```bash [pnpm]
|
||||
pnpm add @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
pnpm add @trpc/server @trpc/client trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [npm]
|
||||
npm install @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
npm install @trpc/server @trpc/client trpc-nuxt zod
|
||||
```
|
||||
|
||||
```bash [yarn]
|
||||
yarn add @trpc/server@next @trpc/client@next trpc-nuxt zod
|
||||
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.
|
||||
@@ -33,8 +41,6 @@ For making typesafe API calls from your client.
|
||||
|
||||
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>
|
||||
```
|
||||
@@ -1,13 +1,11 @@
|
||||
---
|
||||
title: Usage
|
||||
title: Recommended
|
||||
description: tRPC-Nuxt provides first class integration with tRPC.
|
||||
---
|
||||
|
||||
# Usage
|
||||
# Recommended Usage
|
||||
|
||||
## Recommended file structure
|
||||
|
||||
Recommended but not enforced file structure. This is what you get when starting from [the examples](../main/example-apps.md).
|
||||
Recommended but not enforced file structure.
|
||||
|
||||
```graphql
|
||||
.
|
||||
@@ -24,7 +22,7 @@ Recommended but not enforced file structure. This is what you get when starting
|
||||
│ │ ├── context.ts # <-- create app context
|
||||
│ │ └── trpc.ts # <-- procedure helpers
|
||||
├── plugins
|
||||
│ ├── client.ts # <-- tRPC Client as a plugin
|
||||
│ ├── client.ts # <-- tRPC client plugin
|
||||
└── [..]
|
||||
```
|
||||
|
||||
@@ -35,16 +33,26 @@ Initialize your tRPC backend using the `initTRPC` function and create your first
|
||||
::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'
|
||||
|
||||
// Avoid exporting the entire t-object since it's not very
|
||||
// descriptive and can be confusing to newcomers used to t
|
||||
// meaning translation in i18n libraries.
|
||||
const t = initTRPC.create()
|
||||
const t = initTRPC.context<Context>().create()
|
||||
|
||||
// Base router and procedure helpers
|
||||
export const router = t.router
|
||||
export const publicProcedure = t.procedure
|
||||
/**
|
||||
* Unprotected procedure
|
||||
**/
|
||||
export const publicProcedure = t.procedure;
|
||||
export const router = t.router;
|
||||
export const middleware = t.middleware;
|
||||
```
|
||||
|
||||
```ts [server/trpc/routers/index.ts]
|
||||
@@ -71,15 +79,28 @@ export type AppRouter = typeof appRouter
|
||||
|
||||
```ts [server/api/trpc/[trpc].ts]
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { appRouter } from '@/server/trpc/routers'
|
||||
import { appRouter } from '~/server/trpc/routers'
|
||||
import { createContext } from '~/server/trpc/context'
|
||||
|
||||
// export API handler
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
createContext: () => ({}),
|
||||
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}
|
||||
@@ -91,18 +112,18 @@ If you need to split your router into several subrouters, you can implement them
|
||||
Create a strongly-typed plugin using your API's type signature.
|
||||
|
||||
```ts [plugins/client.ts]
|
||||
import { httpBatchLink, createTRPCProxyClient } from '@trpc/client'
|
||||
import type { AppRouter } from '@/server/trpc/routers'
|
||||
import { createTRPCNuxtClient, httpBatchLink } from 'trpc-nuxt/client'
|
||||
import type { AppRouter } from '~/server/trpc/routers'
|
||||
|
||||
export default defineNuxtPlugin(() => {
|
||||
const client = createTRPCProxyClient<AppRouter>({
|
||||
/**
|
||||
* createTRPCNuxtClient adds a `useQuery` composable
|
||||
* built on top of `useAsyncData`.
|
||||
*/
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
links: [
|
||||
httpBatchLink({
|
||||
/**
|
||||
* If you want to use SSR, you need to use the server's full URL
|
||||
* @link https://trpc.io/docs/ssr
|
||||
**/
|
||||
url: 'http://localhost:3000/api/trpc',
|
||||
url: '/api/trpc',
|
||||
}),
|
||||
],
|
||||
})
|
||||
@@ -115,16 +136,18 @@ export default defineNuxtPlugin(() => {
|
||||
})
|
||||
```
|
||||
|
||||
## 3. Make API requests
|
||||
## 3. Make an API request
|
||||
|
||||
```vue [pages/index.vue]
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
|
||||
const data = await $client.hello.query({ text: 'client' })
|
||||
const hello = await $client.hello.useQuery({ text: 'client' })
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<p>{{data?.greeting }}</p>
|
||||
<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 { appRouter } from '@/server/trpc/routers'
|
||||
|
||||
export default defineEventHandler(async (event) => {
|
||||
const { name } = getQuery(event)
|
||||
const caller = appRouter.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 { appRouter } from '@/server/trpc/routers'
|
||||
|
||||
export default defineEventHandler(async (event) => {
|
||||
const body = await getBody(event)
|
||||
const caller = appRouter.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
|
||||
---
|
||||
@@ -24,8 +24,9 @@ End-to-end typesafe APIs in Nuxt applications.
|
||||
|
||||
#extra
|
||||
::list
|
||||
- Automatic typesafety
|
||||
- Automatic typesafety
|
||||
- Snappy DX
|
||||
- Autocompletion
|
||||
- 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)
|
||||
::
|
||||
::
|
||||
|
||||
@@ -7,13 +7,9 @@
|
||||
"generate": "nuxi build",
|
||||
"preview": "nuxi preview"
|
||||
},
|
||||
"dependencies": {
|
||||
"@vueuse/head": "^1.0.3",
|
||||
"nuxt": "^3.0.0-rc.13",
|
||||
"@nuxtjs/tailwindcss": "^6.1.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt-themes/docus": "npm:@nuxt-themes/docus-edge@latest",
|
||||
"@nuxtlabs/github-module": "npm:@nuxtlabs/github-module-edge@latest"
|
||||
"@nuxt-themes/docus": "^1.14.3",
|
||||
"@nuxtlabs/github-module": "^1.6.3",
|
||||
"nuxt": "3.6.5"
|
||||
}
|
||||
}
|
||||
|
||||
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 |
23
examples/basic-example/.gitignore
vendored
Normal file
23
examples/basic-example/.gitignore
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
# Nuxt dev/build outputs
|
||||
.output
|
||||
.nuxt
|
||||
.nitro
|
||||
.cache
|
||||
dist
|
||||
|
||||
# Node dependencies
|
||||
node_modules
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.fleet
|
||||
.idea
|
||||
|
||||
# Local env files
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
2
examples/basic-example/.npmrc
Normal file
2
examples/basic-example/.npmrc
Normal file
@@ -0,0 +1,2 @@
|
||||
shamefully-hoist=true
|
||||
strict-peer-dependencies=false
|
||||
63
examples/basic-example/README.md
Normal file
63
examples/basic-example/README.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Nuxt 3 Minimal Starter
|
||||
|
||||
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
|
||||
|
||||
## Setup
|
||||
|
||||
Make sure to install the dependencies:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm install
|
||||
|
||||
# pnpm
|
||||
pnpm install
|
||||
|
||||
# yarn
|
||||
yarn install
|
||||
```
|
||||
|
||||
## Development Server
|
||||
|
||||
Start the development server on `http://localhost:3000`:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run dev
|
||||
|
||||
# pnpm
|
||||
pnpm run dev
|
||||
|
||||
# yarn
|
||||
yarn dev
|
||||
```
|
||||
|
||||
## Production
|
||||
|
||||
Build the application for production:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run build
|
||||
|
||||
# pnpm
|
||||
pnpm run build
|
||||
|
||||
# yarn
|
||||
yarn build
|
||||
```
|
||||
|
||||
Locally preview production build:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run preview
|
||||
|
||||
# pnpm
|
||||
pnpm run preview
|
||||
|
||||
# yarn
|
||||
yarn preview
|
||||
```
|
||||
|
||||
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
||||
127
examples/basic-example/app.vue
Normal file
127
examples/basic-example/app.vue
Normal file
@@ -0,0 +1,127 @@
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
const { data: product } = await $client.products.useQuery()
|
||||
|
||||
function formatPrice(num: number) {
|
||||
return `£ ${num.toFixed(2)}`
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="product-page">
|
||||
<header class="header">
|
||||
<h1 class="header-title">
|
||||
TRPC-Nuxt Basic Example
|
||||
</h1>
|
||||
</header>
|
||||
<div class="card">
|
||||
<div class="card-content">
|
||||
<h3 class="card-title">
|
||||
{{ product.title }}
|
||||
</h3>
|
||||
<p class="card-description">
|
||||
{{ product.description }}
|
||||
</p>
|
||||
<p class="card-price">
|
||||
{{ formatPrice(product.price) }}
|
||||
</p>
|
||||
<button class="card-button">
|
||||
Add to Cart
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style>
|
||||
body {
|
||||
margin: 0;
|
||||
}
|
||||
.product-page {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
height: 100vh;
|
||||
}
|
||||
|
||||
.header {
|
||||
width: 100%;
|
||||
background-color: #41b883;
|
||||
padding: 16px;
|
||||
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.header-title {
|
||||
margin: 0;
|
||||
font-size: 24px;
|
||||
font-weight: bold;
|
||||
color: #fff;
|
||||
text-align: center;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
.card {
|
||||
width: 300px;
|
||||
border: 1px solid #eaeaea;
|
||||
border-radius: 4px;
|
||||
overflow: hidden;
|
||||
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
|
||||
margin-top: 16px;
|
||||
|
||||
}
|
||||
|
||||
.card-image {
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
.card-content {
|
||||
padding: 16px;
|
||||
background-color: #f9f9f9;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.card-title {
|
||||
margin: 0;
|
||||
font-size: 20px;
|
||||
color: #333;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
.card-description {
|
||||
margin: 8px 0;
|
||||
font-size: 14px;
|
||||
color: #666;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
.card-price {
|
||||
margin: 8px 0;
|
||||
font-size: 18px;
|
||||
font-weight: bold;
|
||||
color: #333;
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
.card-button {
|
||||
display: block;
|
||||
width: 100%;
|
||||
padding: 8px;
|
||||
margin-top: 16px;
|
||||
font-size: 16px;
|
||||
font-weight: bold;
|
||||
text-align: center;
|
||||
color: #fff;
|
||||
background-color: #41b883;
|
||||
border: none;
|
||||
border-radius: 4px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.card-button:hover {
|
||||
background-color: #399d7d;
|
||||
}
|
||||
</style>
|
||||
7
examples/basic-example/nuxt.config.ts
Normal file
7
examples/basic-example/nuxt.config.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
// https://nuxt.com/docs/api/configuration/nuxt-config
|
||||
export default defineNuxtConfig({
|
||||
devtools: { enabled: true },
|
||||
build: {
|
||||
transpile: ['trpc-nuxt'],
|
||||
},
|
||||
})
|
||||
22
examples/basic-example/package.json
Normal file
22
examples/basic-example/package.json
Normal file
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "nuxt-app",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "nuxt build",
|
||||
"dev": "nuxt dev",
|
||||
"generate": "nuxt generate",
|
||||
"preview": "nuxt preview",
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt/devtools": "latest",
|
||||
"@types/node": "^20.4.2",
|
||||
"nuxt": "^3.6.5"
|
||||
},
|
||||
"dependencies": {
|
||||
"@trpc/client": "^10.35.0",
|
||||
"@trpc/server": "^10.35.0",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.21.4"
|
||||
}
|
||||
}
|
||||
22
examples/basic-example/plugins/client.ts
Normal file
22
examples/basic-example/plugins/client.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
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,
|
||||
},
|
||||
}
|
||||
})
|
||||
BIN
examples/basic-example/public/favicon.ico
Normal file
BIN
examples/basic-example/public/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
9
examples/basic-example/server/api/trpc/[trpc].ts
Normal file
9
examples/basic-example/server/api/trpc/[trpc].ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||
import { appRouter } from '../../trpc/routers'
|
||||
import { createContext } from '../../trpc/context'
|
||||
|
||||
// export API handler
|
||||
export default createNuxtApiHandler({
|
||||
router: appRouter,
|
||||
createContext,
|
||||
})
|
||||
9
examples/basic-example/server/trpc/context.ts
Normal file
9
examples/basic-example/server/trpc/context.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
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>
|
||||
27
examples/basic-example/server/trpc/routers/index.ts
Normal file
27
examples/basic-example/server/trpc/routers/index.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { z } from 'zod'
|
||||
import { publicProcedure, router } from '../trpc'
|
||||
|
||||
export const appRouter = router({
|
||||
hello: publicProcedure
|
||||
.input(
|
||||
z.object({
|
||||
text: z.string().nullish(),
|
||||
})
|
||||
)
|
||||
.query(({ input }) => {
|
||||
console.log(input)
|
||||
return {
|
||||
greeting: `hello ${input?.text ?? 'world'}`,
|
||||
}
|
||||
}),
|
||||
products: publicProcedure.query(async () => {
|
||||
return {
|
||||
title: 'TRPC Nuxt',
|
||||
price: 12.0,
|
||||
description: 'Check out the trpc-nuxt repo',
|
||||
}
|
||||
}),
|
||||
})
|
||||
|
||||
// export type definition of API
|
||||
export type AppRouter = typeof appRouter
|
||||
20
examples/basic-example/server/trpc/trpc.ts
Normal file
20
examples/basic-example/server/trpc/trpc.ts
Normal file
@@ -0,0 +1,20 @@
|
||||
/**
|
||||
* 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 '../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
|
||||
3
examples/basic-example/server/tsconfig.json
Normal file
3
examples/basic-example/server/tsconfig.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "../.nuxt/tsconfig.server.json"
|
||||
}
|
||||
4
examples/basic-example/tsconfig.json
Normal file
4
examples/basic-example/tsconfig.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
// https://nuxt.com/docs/guide/concepts/typescript
|
||||
"extends": "./.nuxt/tsconfig.json"
|
||||
}
|
||||
57
package.json
57
package.json
@@ -2,55 +2,61 @@
|
||||
"name": "trpc-nuxt",
|
||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||
"type": "module",
|
||||
"version": "0.4.1",
|
||||
"packageManager": "pnpm@8.6.9",
|
||||
"version": "0.10.7",
|
||||
"license": "MIT",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
".": {
|
||||
"require": "./dist/index.cjs",
|
||||
"import": "./dist/index.mjs"
|
||||
},
|
||||
"./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"
|
||||
"dist",
|
||||
"client.d.ts"
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "concurrently \"pnpm build --watch\" \"pnpm --filter playground dev\"",
|
||||
"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 && npm publish"
|
||||
"release": "changelogen --release && npm publish && git push --follow-tags",
|
||||
"update-deps": "taze -w && pnpm i"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@trpc/client": "^10.0.0-proxy-beta.21",
|
||||
"@trpc/server": "^10.0.0-proxy-beta.21"
|
||||
"@trpc/client": "^10.26.0",
|
||||
"@trpc/server": "^10.26.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"h3": "^0.8.6",
|
||||
"nanoid": "^4.0.0",
|
||||
"nuxt": "^3.0.0-rc.13",
|
||||
"ohash": "^0.1.5",
|
||||
"ufo": "^0.8.6"
|
||||
"h3": "^1.7.1",
|
||||
"ofetch": "^1.1.1",
|
||||
"ohash": "^1.1.2",
|
||||
"ufo": "^1.1.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt/kit": "3.0.0-rc.13",
|
||||
"@nuxtjs/eslint-config-typescript": "^11.0.0",
|
||||
"@trpc/client": "10.0.0-rc.7",
|
||||
"@trpc/server": "10.0.0-rc.7",
|
||||
"bumpp": "^8.2.1",
|
||||
"concurrently": "^7.5.0",
|
||||
"eslint": "^8.25.0",
|
||||
"tsup": "6.4.0",
|
||||
"typescript": "^4.7.4"
|
||||
"@nuxt/eslint-config": "^0.1.1",
|
||||
"@trpc/client": "^10.35.0",
|
||||
"@trpc/server": "^10.35.0",
|
||||
"changelogen": "^0.5.4",
|
||||
"eslint": "^8.45.0",
|
||||
"taze": "^0.11.2",
|
||||
"tsup": "7.1.0",
|
||||
"typescript": "^5.1.6"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"extends": [
|
||||
"@nuxtjs/eslint-config-typescript"
|
||||
"@nuxt/eslint-config"
|
||||
],
|
||||
"rules": {
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
@@ -66,5 +72,10 @@
|
||||
"*.md",
|
||||
"dist",
|
||||
".output"
|
||||
]
|
||||
}
|
||||
],
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"nuxt": "3.6.5"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,6 @@
|
||||
// https://v3.nuxtjs.org/api/configuration/nuxt.config
|
||||
export default defineNuxtConfig({
|
||||
build: {
|
||||
transpile: ['trpc-nuxt']
|
||||
}
|
||||
})
|
||||
|
||||
@@ -9,13 +9,14 @@
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"dependencies": {
|
||||
"@trpc/client": "10.0.0-rc.7",
|
||||
"@trpc/server": "10.0.0-rc.7",
|
||||
"superjson": "^1.11.0",
|
||||
"@trpc/client": "^10.35.0",
|
||||
"@trpc/server": "^10.35.0",
|
||||
"superjson": "^1.13.1",
|
||||
"trpc-nuxt": "workspace:*",
|
||||
"zod": "^3.19.1"
|
||||
"zod": "^3.21.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"nuxt": "^3.0.0-rc.13"
|
||||
"@types/node": "^20.4.2",
|
||||
"nuxt": "3.6.5"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,11 +1,5 @@
|
||||
<script setup lang="ts">
|
||||
const { $client } = useNuxtApp()
|
||||
// const headers = useClientHeaders()
|
||||
|
||||
// const addHeader = () => {
|
||||
// headers.value.authorization = 'Bearer abcdefghijklmnop'
|
||||
// console.log(headers.value)
|
||||
// }
|
||||
|
||||
const addTodo = async () => {
|
||||
const title = Math.random().toString(36).slice(2, 7)
|
||||
@@ -23,7 +17,7 @@ const addTodo = async () => {
|
||||
}
|
||||
}
|
||||
|
||||
const { data: todos, pending, error, refresh } = await useAsyncData(() => $client.todo.getTodos.query())
|
||||
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useQuery()
|
||||
</script>
|
||||
|
||||
<template>
|
||||
@@ -36,8 +30,14 @@ const { data: todos, pending, error, refresh } = await useAsyncData(() => $clien
|
||||
</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}`">
|
||||
<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>
|
||||
|
||||
27
playground/pages/reactive.vue
Normal file
27
playground/pages/reactive.vue
Normal file
@@ -0,0 +1,27 @@
|
||||
<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)
|
||||
</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>
|
||||
@@ -8,8 +8,8 @@ const { data: todo, pending, error } = await useAsyncData(() => $client.todo.get
|
||||
<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>
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
import { createTRPCProxyClient, httpBatchLink, loggerLink } from '@trpc/client'
|
||||
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 = createTRPCProxyClient<AppRouter>({
|
||||
const client = createTRPCNuxtClient<AppRouter>({
|
||||
transformer: superjson,
|
||||
links: [
|
||||
// adds pretty logs to your console in development and logs errors in production
|
||||
@@ -12,9 +13,7 @@ export default defineNuxtPlugin(() => {
|
||||
process.env.NODE_ENV === 'development' ||
|
||||
(opts.direction === 'down' && opts.result instanceof Error)
|
||||
}),
|
||||
httpBatchLink({
|
||||
url: 'http://localhost:3000/api/trpc'
|
||||
})
|
||||
httpBatchLink()
|
||||
]
|
||||
})
|
||||
|
||||
|
||||
@@ -9,9 +9,10 @@ export type Context = inferAsyncReturnType<typeof createContext>
|
||||
* @link https://trpc.io/docs/context
|
||||
*/
|
||||
export function createContext (
|
||||
opts: H3Event
|
||||
event: H3Event
|
||||
) {
|
||||
// for API-response caching see https://trpc.io/docs/caching
|
||||
|
||||
// console.log('cookies', parseCookies(event))
|
||||
|
||||
return {}
|
||||
}
|
||||
|
||||
11041
pnpm-lock.yaml
generated
11041
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,4 @@
|
||||
packages:
|
||||
- playground
|
||||
- examples/*
|
||||
- docs
|
||||
|
||||
84
src/client/index.ts
Normal file
84
src/client/index.ts
Normal file
@@ -0,0 +1,84 @@
|
||||
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, isRef } 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,
|
||||
watch: isRef(input) ? [...(asyncDataOptions.watch || []), input] : asyncDataOptions.watch
|
||||
})
|
||||
}
|
||||
|
||||
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> | null, 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;
|
||||
}
|
||||
14
src/index.ts
14
src/index.ts
@@ -32,7 +32,7 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
|
||||
error: TRPCError
|
||||
type: ProcedureType | 'unknown'
|
||||
path: string | undefined
|
||||
req: H3Event['req']
|
||||
req: H3Event['node']['req']
|
||||
input: unknown
|
||||
ctx: undefined | inferRouterContext<TRouter>
|
||||
}
|
||||
@@ -50,9 +50,13 @@ export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
||||
}
|
||||
|
||||
function getPath (event: H3Event): string | null {
|
||||
if (typeof event.context.params.trpc === 'string') { return event.context.params.trpc }
|
||||
const { params } = event.context
|
||||
|
||||
if (Array.isArray(event.context.params.trpc)) { return event.context.params.trpc.join('/') }
|
||||
if (typeof params?.trpc === 'string') { return params.trpc }
|
||||
|
||||
if (params?.trpc && Array.isArray(params.trpc)) {
|
||||
return (params.trpc as string[]).join('/')
|
||||
}
|
||||
|
||||
return null
|
||||
}
|
||||
@@ -68,7 +72,7 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
||||
const {
|
||||
req,
|
||||
res
|
||||
} = event
|
||||
} = event.node
|
||||
|
||||
const $url = createURL(req.url!)
|
||||
|
||||
@@ -124,3 +128,5 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
||||
return body
|
||||
})
|
||||
}
|
||||
|
||||
export const createH3ApiHandler = createNuxtApiHandler
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
import { defineConfig } from 'tsup'
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/index.ts'],
|
||||
entry: ['src/index.ts', 'src/client/index.ts'],
|
||||
format: ['cjs', 'esm'],
|
||||
splitting: false,
|
||||
clean: true,
|
||||
external: ['#app', '#imports'],
|
||||
external: ['#app', '#imports', /@trpc\/client/, /@trpc\/server/],
|
||||
dts: true,
|
||||
outExtension ({ format }) {
|
||||
return {
|
||||
|
||||
Reference in New Issue
Block a user