mirror of
https://github.com/ArthurDanjou/trpc-nuxt.git
synced 2026-01-14 12:14:40 +01:00
Compare commits
43 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 25e09b2e30 | |||
| 0612716187 | |||
|
|
55712e3027 | ||
|
|
0fec55a3ae | ||
|
|
8f9e398ae2 | ||
|
|
092e3495fd | ||
|
|
230422bb16 | ||
|
|
057c8f8d3a | ||
|
|
9808375f31 | ||
|
|
8e893a2e30 | ||
|
|
f74273190f | ||
|
|
283400d41a | ||
|
|
5221dc0515 | ||
|
|
299ae558ab | ||
|
|
f7eeb104b3 | ||
|
|
c5c762190b | ||
|
|
93cb44288c | ||
|
|
ede749414d | ||
|
|
f2bcf9b68b | ||
|
|
4289dcbfab | ||
|
|
dc317c2ded | ||
|
|
3db0b31d31 | ||
|
|
f86ebcd6d6 | ||
|
|
252f6108cf | ||
|
|
3a395a7d4a | ||
|
|
ec7e0255c2 | ||
|
|
1386832b4a | ||
|
|
120ebc5760 | ||
|
|
adeb5a5afd | ||
|
|
6e47431f35 | ||
|
|
7c9392b209 | ||
|
|
117f7b791f | ||
|
|
735e362958 | ||
|
|
0738a133ca | ||
|
|
97ef8c90b8 | ||
|
|
bec300b750 | ||
|
|
7bbe767495 | ||
|
|
811a634010 | ||
|
|
12d8c97f71 | ||
|
|
3fc261d5e7 | ||
|
|
ad85a78350 | ||
|
|
892d167ff1 | ||
|
|
1c638a8489 |
128
CHANGELOG.md
128
CHANGELOG.md
@@ -1,6 +1,134 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
|
||||||
|
## v0.10.12
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.11...v0.10.12)
|
||||||
|
|
||||||
|
### 🩹 Fixes
|
||||||
|
|
||||||
|
- Expect ofetch missing error response type ([8f9e398](https://github.com/wobsoriano/trpc-nuxt/commit/8f9e398))
|
||||||
|
|
||||||
|
### 💅 Refactors
|
||||||
|
|
||||||
|
- Explicitly copy headers to custom fetcher ([0fec55a](https://github.com/wobsoriano/trpc-nuxt/commit/0fec55a))
|
||||||
|
|
||||||
|
### 📖 Documentation
|
||||||
|
|
||||||
|
- Add response caching page ([9808375](https://github.com/wobsoriano/trpc-nuxt/commit/9808375))
|
||||||
|
- Fix missing title ([057c8f8](https://github.com/wobsoriano/trpc-nuxt/commit/057c8f8))
|
||||||
|
- Fix incorrect syntax ([230422b](https://github.com/wobsoriano/trpc-nuxt/commit/230422b))
|
||||||
|
|
||||||
|
### 📦 Build
|
||||||
|
|
||||||
|
- **deps:** Bump ofetch to 1.3.2 ([092e349](https://github.com/wobsoriano/trpc-nuxt/commit/092e349))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.11
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.10...v0.10.11)
|
||||||
|
|
||||||
|
### 🩹 Fixes
|
||||||
|
|
||||||
|
- Add missing useLazyQuery type ([299ae55](https://github.com/wobsoriano/trpc-nuxt/commit/299ae55))
|
||||||
|
|
||||||
|
### 📖 Documentation
|
||||||
|
|
||||||
|
- Bump @nuxt-themes/docus to 1.14.6 ([f7eeb10](https://github.com/wobsoriano/trpc-nuxt/commit/f7eeb10))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.10
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.9...v0.10.10)
|
||||||
|
|
||||||
|
### 🚀 Enhancements
|
||||||
|
|
||||||
|
- Add useLazyQuery composable ([93cb442](https://github.com/wobsoriano/trpc-nuxt/commit/93cb442))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.9
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.8...v0.10.9)
|
||||||
|
|
||||||
|
### 🚀 Enhancements
|
||||||
|
|
||||||
|
- Add custom query key option ([f2bcf9b](https://github.com/wobsoriano/trpc-nuxt/commit/f2bcf9b))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## v0.10.8
|
||||||
|
|
||||||
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.7...v0.10.8)
|
||||||
|
|
||||||
|
### 💅 Refactors
|
||||||
|
|
||||||
|
- Use built-in getRequestURL from h3 instead of ufo ([252f610](https://github.com/wobsoriano/trpc-nuxt/commit/252f610))
|
||||||
|
- Use stand-alone getErrorShape ([3db0b31](https://github.com/wobsoriano/trpc-nuxt/commit/3db0b31))
|
||||||
|
|
||||||
|
### 📖 Documentation
|
||||||
|
|
||||||
|
- Add handler param description ([f86ebcd](https://github.com/wobsoriano/trpc-nuxt/commit/f86ebcd))
|
||||||
|
|
||||||
|
### 📦 Build
|
||||||
|
|
||||||
|
- **deps:** Bump h3 to 1.8.0 ([3a395a7](https://github.com/wobsoriano/trpc-nuxt/commit/3a395a7))
|
||||||
|
- Bump local deps ([dc317c2](https://github.com/wobsoriano/trpc-nuxt/commit/dc317c2))
|
||||||
|
|
||||||
|
### ❤️ Contributors
|
||||||
|
|
||||||
|
- Wobsoriano ([@wobsoriano](http://github.com/wobsoriano))
|
||||||
|
|
||||||
|
## 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
|
## v0.10.4
|
||||||
|
|
||||||
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.3...v0.10.4)
|
[compare changes](https://github.com/wobsoriano/trpc-nuxt/compare/v0.10.3...v0.10.4)
|
||||||
|
|||||||
@@ -27,11 +27,11 @@ export const router = t.router({
|
|||||||
```
|
```
|
||||||
|
|
||||||
```ts [server/api/greeting.ts]
|
```ts [server/api/greeting.ts]
|
||||||
import { router } from '@/server/trpc/trpc'
|
import { appRouter } from '@/server/trpc/routers'
|
||||||
|
|
||||||
export default eventHandler(async (event) => {
|
export default defineEventHandler(async (event) => {
|
||||||
const { name } = getQuery(event)
|
const { name } = getQuery(event)
|
||||||
const caller = router.createCaller({})
|
const caller = appRouter.createCaller({})
|
||||||
|
|
||||||
const greeting = await caller.greeting({ name })
|
const greeting = await caller.greeting({ name })
|
||||||
|
|
||||||
@@ -67,11 +67,11 @@ export const router = t.router({
|
|||||||
```
|
```
|
||||||
|
|
||||||
```ts [server/api/post.ts]
|
```ts [server/api/post.ts]
|
||||||
import { router } from '@/server/trpc/trpc'
|
import { appRouter } from '@/server/trpc/routers'
|
||||||
|
|
||||||
export default eventHandler(async (event) => {
|
export default defineEventHandler(async (event) => {
|
||||||
const body = await getBody(event)
|
const body = await getBody(event)
|
||||||
const caller = router.createCaller({})
|
const caller = appRouter.createCaller({})
|
||||||
|
|
||||||
const post = await caller.post.add(body.post)
|
const post = await caller.post.add(body.post)
|
||||||
|
|
||||||
|
|||||||
51
docs/content/1.get-started/5.tips/6.response-caching.md
Normal file
51
docs/content/1.get-started/5.tips/6.response-caching.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
title: Response Caching
|
||||||
|
---
|
||||||
|
|
||||||
|
## Response Caching
|
||||||
|
|
||||||
|
Your server responses must [satisfy some criteria](https://vercel.com/docs/concepts/functions/serverless-functions/edge-caching) in order for them to be cached (i.e. by Vercel's Edge Network). Please refer to [this section of the tRPC.io documentation](https://trpc.io/docs/caching) for more information.
|
||||||
|
|
||||||
|
The `createNuxtApiHandler` function conveniently allows you to specify a `responseMeta` function.
|
||||||
|
|
||||||
|
```ts [server/api/trpc/[trpc].ts]
|
||||||
|
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||||
|
import { appRouter } from '~/server/trpc/routers'
|
||||||
|
|
||||||
|
export default createNuxtApiHandler({
|
||||||
|
router: appRouter,
|
||||||
|
/**
|
||||||
|
* @link https://trpc.io/docs/caching#api-response-caching
|
||||||
|
*/
|
||||||
|
responseMeta(opts) {
|
||||||
|
// cache request for 1 day + revalidate once every second
|
||||||
|
const ONE_DAY_IN_SECONDS = 60 * 60 * 24;
|
||||||
|
|
||||||
|
return {
|
||||||
|
headers: {
|
||||||
|
'cache-control': `s-maxage=1, stale-while-revalidate=${ONE_DAY_IN_SECONDS}`,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
},
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also take advantage of Nitro's [Cache API](https://nitro.unjs.io/guide/cache#cache-api) if doing server-side calls:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { appRouter } from '@/server/trpc/routers'
|
||||||
|
|
||||||
|
const caller = appRouter.createCaller({})
|
||||||
|
|
||||||
|
export default cachedEventHandler(async (event) => {
|
||||||
|
const { name } = getQuery(event)
|
||||||
|
|
||||||
|
const greeting = await caller.greeting({ name })
|
||||||
|
|
||||||
|
return {
|
||||||
|
greeting
|
||||||
|
}
|
||||||
|
}, {
|
||||||
|
swr: true, maxAge: 10
|
||||||
|
})
|
||||||
|
```
|
||||||
@@ -8,8 +8,8 @@
|
|||||||
"preview": "nuxi preview"
|
"preview": "nuxi preview"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nuxt-themes/docus": "^1.12.0",
|
"@nuxt-themes/docus": "^1.14.6",
|
||||||
"@nuxtlabs/github-module": "^1.6.3",
|
"@nuxtlabs/github-module": "^1.6.3",
|
||||||
"nuxt": "3.4.3"
|
"nuxt": "3.6.5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
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": "nuxi build",
|
||||||
|
"dev": "nuxi dev",
|
||||||
|
"generate": "nuxi generate",
|
||||||
|
"preview": "nuxi preview",
|
||||||
|
"postinstall": "nuxi prepare"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@nuxt/devtools": "latest",
|
||||||
|
"@types/node": "20.5.7",
|
||||||
|
"nuxt": "^3.7.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@trpc/client": "^10.38.1",
|
||||||
|
"@trpc/server": "^10.38.1",
|
||||||
|
"trpc-nuxt": "workspace:*",
|
||||||
|
"zod": "^3.22.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
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"
|
||||||
|
}
|
||||||
37
package.json
37
package.json
@@ -2,8 +2,8 @@
|
|||||||
"name": "trpc-nuxt",
|
"name": "trpc-nuxt",
|
||||||
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
"description": "End-to-end typesafe APIs in Nuxt applications.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"packageManager": "pnpm@8.5.1",
|
"packageManager": "pnpm@8.6.9",
|
||||||
"version": "0.10.4",
|
"version": "0.10.12",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"sideEffects": false,
|
"sideEffects": false,
|
||||||
"exports": {
|
"exports": {
|
||||||
@@ -35,24 +35,23 @@
|
|||||||
"update-deps": "taze -w && pnpm i"
|
"update-deps": "taze -w && pnpm i"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@trpc/client": "^10.26.0",
|
"@trpc/client": "^10.38.1",
|
||||||
"@trpc/server": "^10.26.0"
|
"@trpc/server": "^10.38.1"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"h3": "^1.6.6",
|
"h3": "^1.8.1",
|
||||||
"ofetch": "^1.0.1",
|
"ofetch": "^1.3.3",
|
||||||
"ohash": "^1.1.2",
|
"ohash": "^1.1.3"
|
||||||
"ufo": "^1.1.2"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@nuxt/eslint-config": "^0.1.1",
|
"@nuxt/eslint-config": "^0.2.0",
|
||||||
"@trpc/client": "^10.28.0",
|
"@trpc/client": "^10.38.1",
|
||||||
"@trpc/server": "^10.28.0",
|
"@trpc/server": "^10.38.1",
|
||||||
"changelogen": "^0.5.3",
|
"changelogen": "^0.5.5",
|
||||||
"eslint": "^8.41.0",
|
"eslint": "^8.48.0",
|
||||||
"taze": "^0.10.1",
|
"taze": "^0.11.2",
|
||||||
"tsup": "6.7.0",
|
"tsup": "7.2.0",
|
||||||
"typescript": "^5.0.4"
|
"typescript": "^5.2.2"
|
||||||
},
|
},
|
||||||
"eslintConfig": {
|
"eslintConfig": {
|
||||||
"extends": [
|
"extends": [
|
||||||
@@ -75,7 +74,9 @@
|
|||||||
],
|
],
|
||||||
"pnpm": {
|
"pnpm": {
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"nuxt": "3.4.3"
|
"nuxt": "3.7.0",
|
||||||
|
"@trpc/client": "10.38.1",
|
||||||
|
"@trpc/server": "10.38.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,21 +2,21 @@
|
|||||||
"name": "playground",
|
"name": "playground",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "nuxt build",
|
"build": "nuxi build",
|
||||||
"dev": "nuxt dev",
|
"dev": "nuxi dev",
|
||||||
"generate": "nuxt generate",
|
"generate": "nuxi generate",
|
||||||
"preview": "nuxt preview",
|
"preview": "nuxi preview",
|
||||||
"postinstall": "nuxt prepare"
|
"postinstall": "nuxi prepare"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@trpc/client": "^10.28.0",
|
"@trpc/client": "10.38.1",
|
||||||
"@trpc/server": "^10.28.0",
|
"@trpc/server": "10.38.1",
|
||||||
"superjson": "^1.12.3",
|
"superjson": "^1.13.1",
|
||||||
"trpc-nuxt": "workspace:*",
|
"trpc-nuxt": "workspace:*",
|
||||||
"zod": "^3.21.4"
|
"zod": "^3.22.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^18.16.15",
|
"@types/node": "20.5.7",
|
||||||
"nuxt": "3.4.3"
|
"nuxt": "3.7.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ const addTodo = async () => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useQuery()
|
const { data: todos, pending, error, refresh } = await $client.todo.getTodos.useLazyQuery()
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
|
|||||||
@@ -6,9 +6,7 @@ const id = ref(1)
|
|||||||
// watch: [id]
|
// watch: [id]
|
||||||
// })
|
// })
|
||||||
|
|
||||||
const { data: todo, pending, error, refresh } = await $client.todo.getTodo.useQuery(id, {
|
const { data: todo, pending, error, refresh } = await $client.todo.getTodo.useQuery(id)
|
||||||
watch: [id],
|
|
||||||
})
|
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { createNuxtApiHandler } from 'trpc-nuxt'
|
import { createNuxtApiHandler } from 'trpc-nuxt'
|
||||||
import { appRouter } from '@/server/trpc/routers'
|
import { appRouter } from '../../trpc/routers'
|
||||||
import { createContext } from '@/server/trpc/context'
|
import { createContext } from '../../trpc/context'
|
||||||
|
|
||||||
export default createNuxtApiHandler({
|
export default createNuxtApiHandler({
|
||||||
router: appRouter,
|
router: appRouter,
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import { z } from 'zod'
|
import { z } from 'zod'
|
||||||
import { publicProcedure, router } from '../trpc'
|
import { publicProcedure, router } from '../trpc'
|
||||||
|
import { $fetch } from 'ofetch'
|
||||||
|
|
||||||
const baseURL = 'https://jsonplaceholder.typicode.com'
|
const baseURL = 'https://jsonplaceholder.typicode.com'
|
||||||
|
|
||||||
|
|||||||
3
playground/server/tsconfig.json
Normal file
3
playground/server/tsconfig.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "../.nuxt/tsconfig.server.json"
|
||||||
|
}
|
||||||
5463
pnpm-lock.yaml
generated
5463
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,3 +1,4 @@
|
|||||||
packages:
|
packages:
|
||||||
- playground
|
- playground
|
||||||
|
- examples/*
|
||||||
- docs
|
- docs
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { createFlatProxy, createRecursiveProxy } from '@trpc/server/shared'
|
|||||||
import { hash } from 'ohash'
|
import { hash } from 'ohash'
|
||||||
import { type DecoratedProcedureRecord } from './types'
|
import { type DecoratedProcedureRecord } from './types'
|
||||||
// @ts-expect-error: Nuxt auto-imports
|
// @ts-expect-error: Nuxt auto-imports
|
||||||
import { getCurrentInstance, onScopeDispose, useAsyncData, unref } from '#imports'
|
import { getCurrentInstance, onScopeDispose, useAsyncData, unref, isRef } from '#imports'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calculates the key used for `useAsyncData` call.
|
* Calculates the key used for `useAsyncData` call.
|
||||||
@@ -40,8 +40,8 @@ export function createNuxtProxyDecoration<TRouter extends AnyRouter> (name: stri
|
|||||||
|
|
||||||
const [input, otherOptions] = args
|
const [input, otherOptions] = args
|
||||||
|
|
||||||
if (lastArg === 'useQuery') {
|
if (['useQuery', 'useLazyQuery'].includes(lastArg)) {
|
||||||
const { trpc, ...asyncDataOptions } = otherOptions || {} as any
|
const { trpc, queryKey: customQueryKey, ...asyncDataOptions } = otherOptions || {} as any
|
||||||
|
|
||||||
let controller: AbortController
|
let controller: AbortController
|
||||||
|
|
||||||
@@ -54,11 +54,18 @@ export function createNuxtProxyDecoration<TRouter extends AnyRouter> (name: stri
|
|||||||
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
|
controller = typeof AbortController !== 'undefined' ? new AbortController() : {} as AbortController
|
||||||
}
|
}
|
||||||
|
|
||||||
const queryKey = getQueryKey(path, unref(input))
|
const queryKey = customQueryKey || getQueryKey(path, unref(input))
|
||||||
|
const watch = isRef(input) ? [...(asyncDataOptions.watch || []), input] : asyncDataOptions.watch
|
||||||
|
const isLazy = lastArg === 'useLazyQuery' ? true : (asyncDataOptions.lazy || false)
|
||||||
|
|
||||||
return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
|
return useAsyncData(queryKey, () => (client as any)[path].query(unref(input), {
|
||||||
signal: controller?.signal,
|
signal: controller?.signal,
|
||||||
...trpc
|
...trpc
|
||||||
}), asyncDataOptions)
|
}), {
|
||||||
|
...asyncDataOptions,
|
||||||
|
watch,
|
||||||
|
lazy: isLazy
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
return (client as any)[path][lastArg](...args)
|
return (client as any)[path][lastArg](...args)
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ function customFetch(input: RequestInfo | URL, init?: RequestInit & { method: 'G
|
|||||||
})
|
})
|
||||||
.then(response => ({
|
.then(response => ({
|
||||||
...response,
|
...response,
|
||||||
|
headers: response.headers,
|
||||||
json: () => Promise.resolve(response._data)
|
json: () => Promise.resolve(response._data)
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -53,14 +53,37 @@ type DecorateProcedure<
|
|||||||
> = TProcedure extends AnyQueryProcedure
|
> = TProcedure extends AnyQueryProcedure
|
||||||
? {
|
? {
|
||||||
useQuery: <
|
useQuery: <
|
||||||
ResT = inferTransformedProcedureOutput<TProcedure>,
|
ResT = inferTransformedProcedureOutput<TProcedure>,
|
||||||
DataE = TRPCClientErrorLike<TProcedure>,
|
DataE = TRPCClientErrorLike<TProcedure>,
|
||||||
DataT = ResT,
|
DataT = ResT,
|
||||||
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
||||||
>(
|
>(
|
||||||
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
||||||
opts?: AsyncDataOptions<ResT, DataT, PickKeys> & { trpc?: TRPCRequestOptions },
|
opts?: AsyncDataOptions<ResT, DataT, PickKeys> & {
|
||||||
) => AsyncData<PickFrom<DataT, PickKeys>, DataE>,
|
trpc?: TRPCRequestOptions
|
||||||
|
/**
|
||||||
|
* The custom unique key to use.
|
||||||
|
* @see https://nuxt.com/docs/api/composables/use-async-data#params
|
||||||
|
*/
|
||||||
|
queryKey?: string
|
||||||
|
},
|
||||||
|
) => AsyncData<PickFrom<DataT, PickKeys> | null, DataE>,
|
||||||
|
useLazyQuery: <
|
||||||
|
ResT = inferTransformedProcedureOutput<TProcedure>,
|
||||||
|
DataE = TRPCClientErrorLike<TProcedure>,
|
||||||
|
DataT = ResT,
|
||||||
|
PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
|
||||||
|
>(
|
||||||
|
input: MaybeRef<inferProcedureInput<TProcedure>>,
|
||||||
|
opts?: Omit<AsyncDataOptions<ResT, DataT, PickKeys>, 'lazy'> & {
|
||||||
|
trpc?: TRPCRequestOptions
|
||||||
|
/**
|
||||||
|
* The custom unique key to use.
|
||||||
|
* @see https://nuxt.com/docs/api/composables/use-async-data#params
|
||||||
|
*/
|
||||||
|
queryKey?: string
|
||||||
|
},
|
||||||
|
) => AsyncData<PickFrom<DataT, PickKeys> | null, DataE>,
|
||||||
query: Resolver<TProcedure>
|
query: Resolver<TProcedure>
|
||||||
} : TProcedure extends AnyMutationProcedure ? {
|
} : TProcedure extends AnyMutationProcedure ? {
|
||||||
mutate: Resolver<TProcedure>
|
mutate: Resolver<TProcedure>
|
||||||
|
|||||||
27
src/index.ts
27
src/index.ts
@@ -9,10 +9,10 @@ import type {
|
|||||||
import {
|
import {
|
||||||
TRPCError
|
TRPCError
|
||||||
} from '@trpc/server'
|
} from '@trpc/server'
|
||||||
import { createURL } from 'ufo'
|
|
||||||
import type { H3Event } from 'h3'
|
import type { H3Event } from 'h3'
|
||||||
import { createError, defineEventHandler, isMethod, readBody } from 'h3'
|
import { createError, defineEventHandler, getRequestURL, isMethod, readBody } from 'h3'
|
||||||
import type { TRPCResponse } from '@trpc/server/rpc'
|
import type { TRPCResponse } from '@trpc/server/rpc'
|
||||||
|
import { getErrorShape } from '@trpc/server/shared'
|
||||||
|
|
||||||
type MaybePromise<T> = T | Promise<T>
|
type MaybePromise<T> = T | Promise<T>
|
||||||
|
|
||||||
@@ -40,9 +40,25 @@ export interface OnErrorPayload<TRouter extends AnyRouter> {
|
|||||||
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
export type OnErrorFn<TRouter extends AnyRouter> = (opts: OnErrorPayload<TRouter>) => void
|
||||||
|
|
||||||
export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
export interface ResolveHTTPRequestOptions<TRouter extends AnyRouter> {
|
||||||
|
/**
|
||||||
|
* The tRPC router to use.
|
||||||
|
* @see https://trpc.io/docs/router
|
||||||
|
*/
|
||||||
router: TRouter
|
router: TRouter
|
||||||
|
/**
|
||||||
|
* An async function that returns the tRPC context.
|
||||||
|
* @see https://trpc.io/docs/context
|
||||||
|
*/
|
||||||
createContext?: CreateContextFn<TRouter>
|
createContext?: CreateContextFn<TRouter>
|
||||||
|
/**
|
||||||
|
* A function that returns the response meta.
|
||||||
|
* @see https://trpc.io/docs/caching#using-responsemeta-to-cache-responses
|
||||||
|
*/
|
||||||
responseMeta?: ResponseMetaFn<TRouter>
|
responseMeta?: ResponseMetaFn<TRouter>
|
||||||
|
/**
|
||||||
|
* A function that is called when an error occurs.
|
||||||
|
* @see https://trpc.io/docs/error-handling#handling-errors
|
||||||
|
*/
|
||||||
onError?: OnErrorFn<TRouter>
|
onError?: OnErrorFn<TRouter>
|
||||||
batching?: {
|
batching?: {
|
||||||
enabled: boolean
|
enabled: boolean
|
||||||
@@ -74,15 +90,16 @@ export function createNuxtApiHandler<TRouter extends AnyRouter> ({
|
|||||||
res
|
res
|
||||||
} = event.node
|
} = event.node
|
||||||
|
|
||||||
const $url = createURL(req.url!)
|
const $url = getRequestURL(event)
|
||||||
|
|
||||||
const path = getPath(event)
|
const path = getPath(event)
|
||||||
|
|
||||||
if (path === null) {
|
if (path === null) {
|
||||||
const error = router.getErrorShape({
|
const error = getErrorShape({
|
||||||
|
config: router._def._config,
|
||||||
error: new TRPCError({
|
error: new TRPCError({
|
||||||
message:
|
message:
|
||||||
'Param "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
|
'Query "trpc" not found - is the file named `[trpc]`.ts or `[...trpc].ts`?',
|
||||||
code: 'INTERNAL_SERVER_ERROR'
|
code: 'INTERNAL_SERVER_ERROR'
|
||||||
}),
|
}),
|
||||||
type: 'unknown',
|
type: 'unknown',
|
||||||
|
|||||||
Reference in New Issue
Block a user